Ⅰ RESTful API规范简介
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。
Ⅱ 数据的安全保障
url链接一般都采用https协议进行传输
- 注：采用https协议，可以提高数据交互过程中的安全性
Ⅲ 接口特征表现
用api关键字标识接口url：
- 注：看到api字眼，就代表该请求url链接是完成前后台数据交互的
Ⅳ 多数据版本共存
在url链接中标识数据版本
- 注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）
Ⅴ 数据即是资源，均使用名词（可复数）
接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
- 注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义
Ⅵ 资源操作由请求方式决定（method）
操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
- https://api.baidu.com/books - get请求：获取所有书
- https://api.baidu.com/books/1 - get请求：获取主键为1的书
- https://api.baidu.com/books - post请求：新增一本书书
- https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
- https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
- https://api.baidu.com/books/1 - delete请求：删除主键为1的书
Ⅷ 响应状态码
正常响应
- 响应状态码2xx
- 200：常规请求
- 201：创建成功
重定向响应
- 响应状态码3xx
- 301：永久重定向
- 302：暂时重定向
客户端异常
- 响应状态码4xx
- 403：请求无权限
- 404：请求路径不存在
- 405：请求方法不存在
服务器异常
- 响应状态码5xx
- 500：服务器异常
Ⅸ 错误处理，应返回错误信息，error当做key
Ⅹ 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
Ⅺ 需要url请求的资源需要访问资源的请求链接
比较好的接口返回
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
