RESTful API 微服务 接口设计规则

RESTful API

是目前流行的 Web 的 API 设计规则，为用户提供一种方便易于理解的 API，提供一种通用的设计规范

设计原则

动词 + 宾语 ： 比如 get /asset 也就是获取 asset 信息，

动词

5种如下

• GET：读取（Read）
• POST：新建（Create）
• PUT：更新（Update）
• PATCH：部分更新
• DELETE：删除（Delete）
  其中 http 提供 get post 两种，其他三种需要设置post参数模拟

宾语

url 信息，必须是名词

状态码

https://blog.csdn.net/jinbangshi9469/article/details/93517869
有五种：
1** 信息，服务器收到请求，需要请求者继续执行操作
2** 成功，操作被成功接收并处理
3** 重定向，需要进一步的操作以完成请求
4** 客户端错误，请求包含语法错误或无法完成请求
5** 服务器错误，服务器在处理请求的过程中发生了错误

回应

must：

发生错误时，不要返回200 ok

suggestion

不要返回纯文本：设置可以接收的格式和发送的格式
链接提供：通过一个通用api获取相关联操作的 api - url

ref

RESTful API Design: 13 Best Practices to Make Your Users Happy, by Florimond Manca
API design, by MicroSoft Azure