含义：

  • HTTP Methods：也叫 HTTP Verbs，HTTP Methods 可以翻译成 HTTP 方法。它们是 HTTP 协议的一部分，主要规定了 HTTP 如何请求和操作服务器上的资源，常见的有GET，POST等。
  • API：Application Programming Interface 应用程序接口，RESTful API，这类API是通过 HTTP 协议 URL 形式暴露给其它系统或者模块调用，比如，一个获得用户所有评论的 API 可能像这样：https://api.server-name.com/user-id/comments

HTTP Methods 一共有九个，分别是 GET，HEAD，POST，PUT，DELETE，TRACE，OPTIONS，CONNECT，PATCH

RESTful API 设计中，常用的有POST，GET，PUT，PATCH 和 DELETE,分别对应对资源的创建，获取，修改，部分修改和删除操作。

Methods的用途和返回值约定

| HTTP Methods | 操作方式（CRUD） | 获取多个资源（/books）返回结果 |获取单个资源(/books/id) 返回结果

| POST| 创建数据 Create| 201 (Created) <br /> HTTP Header 'Location' 值设置为/books/id，其中id为新创建的book id | 404 (Not Found), <br />如果资源已经存在，返回409 (Conflict)|
| GET| 读取数据 Read |200 (OK) <br /> 在Body中返回所有的books，可以使用参数来获取部分books数据如/books?page=3 | 200 (OK)<br />在Body中返回对应id的book<br /><br />404 (Not Found) <br />如果没有对应数据，或者id格式不对 |
| PUT| 修改数据 Update <br /><br />整条修改<br />修改除ID外的所有属性 |404 (Not Found) <br />除非该API要实现批量或者全部更新可返回200，否则一般直接返回404即可 |200 (OK) <br /> 204 (No Content)<br /> 404 (Not Found), 如果id格式不正确或者没有找到|
| PATCH| 修改数据 Update <br /><br />部分修改 <br /> 修改一条记录的部分属性 |404 (Not Found) <br />除非该API要实现批量或者全部更新可返回200，否则一般直接返回404即可 |200 (OK) <br /> 204 (No Content)<br /> 404 (Not Found), 如果id格式不正确或者没有找到 |

| DELETE| 删除数据 Delete| 404 (Not Found)<br />一般直接返回404 除非你真的想删除全部集合可返回200 |200 (OK)
404 (Not Found) 如果id格式不正确或者没有找到 |

HTTP Methods 使用详细说明
POST
　　使用 POST 的 API 一般用来表示创建一条数据。举例来说，如果要设计一个向后端数据库添加一条关于图书信息等 API，可以设计成：https://api.servers.com/books
  • 客户端调用：客户端把要创建的数据放在HTTP请求的Body中，比如Body数据是{title: "Are your lights on", author: "Donald C. Gause"}之后发送 HTTP POST 请求到https://api.server.com/books
  • 服务端实现
    • 服务端在收到客户端 POST 来的数据时，根据POST URL，发现应该创建books数据。
    • 之后获取 body 里面的内容来创建一条新 book 记录并保存，如果一切正常，返回201表示创建成功。
    • 返回时将 HTTP Header 'Location' 值设置为https://api.server.com/books/new-created-book-id
    • 客户端可以获得该条刚创建数据的 Unique ID，方便在需要进一步操作时使用

　　注意：POST API 不是一个数据安全和幂等性操作，如果客户端多次调用同样的 API 会导致多条数据被创建，这些数据除了 ID 不同其他属性都相同。

　　举例：

　　POST https://api.server.com/books

　　POST https://api.server.com/books/123456/comments

GET

　　一般用于读取数据，即获取资源。成功调用 GET API 会返回相应的数据。如果请求的数据不存在可返回404（Not Found）或者由于参数不正确的原因可以返回400（Bad Request）

  • 客户端调用：客户端只要简单发送一个 HTTP GET 请求到相应的 URL 即可，请求URL 中可以带上有关参数用来对数据进行条件过滤，如：GET https://api.server.com/books?author=gause
  • 服务端实现：服务端在收到相应的请求之后根据 URL 判断应该返回什么类型的数据，并且根据 URL 参数对数据进行过滤后在放在 Body 中返回给客户端。GET 可以返回一个集合，类似数组的形式。如：

　　

　　如果客户端只请求一条数据 GET https://api.server.com/books/000，应该返回对应ID的数据即可：

注意：GET操作是数据安全和具有幂等性的操作，也就是多次调用GET应该返回相同的数据（期间没有修改操作的前提下），并且不会导致任何数据的破坏性修改。

  　　API举例：

　　GET https://api.server.com/books/123456
　　GET https://api.server.com/books/123456/comments
　　GET https://api.server.com/books/123456/comments/id001
　　GET https://api.server.com/books?author=gause
PUT：一般用来更新记录，和 PATCH 不同的是，PUT 一般用于替换该记录的所有属性。PATCH 只是部分更新。和 POST 不同的是，PUT 不会生成新的资源 ID，而 POST 会生成并且返回新创建的数据 ID

　　客户端调用：POST 调用方式几乎相同，比如要修改的数据是{id: "book-id-000", title: "Are your lights on", author: "Donald C. Gause"}客户端发送 HTTP PUT 请求到https://api.server.com/books。和POST不同的是，该操作会带上数据的 UID，用来定位具体要修改的这一条数据，方便后续操作。也有的设计会把ID放在URL中https://api.server.com/books/book-id-000，这样要修改的Body中的数据可以不用包含ID

　　服务端实现：如果更新成功 PUT API 应该返回200。如果 PUT 请求的 body 中没有任何信息则返回204, 如果id没有找到或id格式不正确，返回404。和POST不同的是该 API 没有必要在Header中更新刚创建数据ID URL，因为我们是在修改该条数据，其 ID 之前已经被客户的获取。

　　注意：PUT 操作不是数据安全的，因为这个操作改变了数据，但是PUT操作是幂等性的，对于相同的PUT请求，无论调用多少次，造成的数据修改的结果永远和调第一次时相同。
       API举例：
　　PUT https://api.server.com/books/123456
    PUT https://api.server.com/books/123456/comments/id001
PATCH：PATCH 操作只更新部分数据，比如有这么一条数据{id:000, title: "Are your lights on", author: "Donald C. Gause", pub:"xyz"}PATCH 操作可能只是修改 title，或者修改 pub，具体修改的内容由body 里面的数据格式规定。而 PUT API 中 body 数据一般是要替换所有数据的属性（除了ID以外）。
　　客户端调用：
　　　　和 PUT 不同的只是 Body 的数据格式，PUT 请求的 Body 一般是这样的
　　　　{title: "Are your lights on"} 只包含部分要修改的数据
　　服务端实现：服务端根据 Body 的内容对该条数据进行部分更新。成功更新数据应该返回200，当数据 ID 没有找到返回404。
　　注意：PATCH 操作其实不是幂等性操作，也不是数据安全的，来自不同的客户端的 PATCH 请求可能让数据部分属性相互覆盖和冲突
　　API举例：PATCH https://api.server.com/books/123456        PATCH https://api.server.com/books/123456/comments/id001
DELETE：删除一条数据，正确删除后应该返回200，如果要删除的资源ID不存在则返回404，DELETE 在HTTP 协议语义中是幂等性的，无论调用多少次之后，该数据都是同样的被删除状态。
　　API举例：DELETE https://api.server.com/books/123456     DELETE https://api.server.com/books/123456/comments/id001
 
 
 
 
 
 
　　

最新文章

  1. Less函数说明
  2. 【转】MySQL数据丢失讨论
  3. 每天一个linux命令（39）：grep 命令
  4. [CareerCup] 18.11 Maximum Subsquare 最大子方形
  5. Sqoop_ 简单介绍
  6. Web前端之html_day1
  7. CSS3选择器（一）之基本选择器
  8. PHP 设计模式之观察者模式
  9. jqueryGrid 内置的onclickSubmit afterSubmit
  10. Ajax的“dataType”乱用的陷阱
  11. C#学习笔记(三)
  12. python word操作深入
  13. C/C++ - 结构体实际申请的空间
  14. [转]Oracle 创建 DBLink 的方法
  15. deeplearning.ai 神经网络和深度学习 week1 深度学习概论 听课笔记
  16. 功能性AI术语表
  17. [LeetCode] Replace Words 替换单词
  18. vue学习笔记（三）- vue2.x引入Element-ui
  19. k8s之Hello World（四）
  20. opencv 霍夫变换 实现图片旋转角度计算

热门文章

  1. css 使用率 清楚无用css
  2. IQC来料检验报表
  3. springcloud之eureka配置——eureka.instance
  4. 创建型模式篇（单例模式Single Pattern）
  5. loj 10117 简单题（cqoi 2006)
  6. vue 项目中命名方法
  7. vscode代码保存时自动格式化成ESLint风格（支持VUE）
  8. MSOCache office问题
  9. astah-professional-7_2_0安装
  10. TCP_NODELAY算法使用事项