当前位置:网站首页>什么是 Restful 动词

什么是 Restful 动词

2022-07-23 23:52:00 InfoQ

REST 动词指定要对特定资源或资源集合执行的操作。当客户端发出请求时,它应该在 HTTP 请求中发送以下信息:

  • REST 动词
  • 头信息
  • 主体(可选)
REST 使用 URI 来解码其要处理的资源。有很多可用的 REST 动词,但其中有六个是经常使用的。它们如下:
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
  • OPTIONS
如果您是软件开发人员,那么您大部分时间都会处理这六个问题。下表说明了操作、目标资源以及请求成功或失败时会发生什么:

上表的成功和失败列中的数字是HTTP状态代码。每当客户端启动REST操作时,休息是无状态的,客户应该知道操作方法是否成功。因此,HTTP具有响应的状态代码。RET定义给定操作的前一个状态代码类型。这意味着REST API应严格遵循前面的规则来实现客户端 - 服务器通信。

所有定义的 REST 服务都具有以下格式。它由主机和 API 端点组成。 API 端点是服务器预定义的 URL 路径。每个 REST 请求都应该到达该路径。

REST API URI:
http://HostName/API endpoint/Query(optional)

让我们更详细地查看所有动词。REST API设计始于操作的定义和API端点。在实现API之前,设计文档应列出给定资源的所有端点。在以下部分中,我们仔细观察使用PayPal的REST API作为用例的REST API端点。

GET 方法

GET 方法从服务器获取给定的资源。为了指定一个资源,GET 使用了几种类型的 URI 查询:
  • 查询参数
  • 基于路径的参数
如果您不知道,您对网络的所有浏览都是通过对服务器执行Get请求来完成的。例如,如果您键入www.google.com,则实际上是获取获取搜索页面的GET请求。在这里,您的浏览器是客户端,Google的Web服务器是Web服务的后端实现者。成功的Get操作返回200个状态代码。

路径参数的示例:

每个人都知道 PayPal。PayPal 与公司创建结算协议。如果您注册 PayPal 的支付系统,他们为您提供 REST API,以满足您的所有帐单需求。示例获取获取结算协议信息的请求如下所示:
/v1/payments/billing-agreements/agreement_id
.


原网站

版权声明
本文为[InfoQ]所创,转载请带上原文链接,感谢
https://xie.infoq.cn/article/bd53e3eb04261aa0c57c0006f