Restful风格API规范

Restful风格API规范
Restfun API
协议
域名
版本
路径
HTTP动词
过滤信息(Filtering)
状态码(Status Codes)
错误处理(Error handling)
返回结果
Restfun API
REST（Representational State Transfer）全称是表属性状态转移，其实指的就是资源的表述。如果一个架构符合REST原则，就称为Restful架构。

解决问题：降低开发的复杂性；提高系统的可伸缩性。

Restful只是后端提供给前端得API一种风格，把并不是API开发的标准，在实现功能上和其他风格或者自定义类型是没有太大区别的，只是大家用的多都认同渐渐就成了一种约定俗成的规范。

协议

常用HTTPS协议。

域名

初学者练手小唐不建议将API部署在专用域名上（存在跨域问题）：
https://api.loveliuya.com
可以放在主域名下，如下：
https://loveliuya.com/api/

版本

为了方便后期更新和维护，可以把API的版本好放在URL里，通常用version的首字母v+版本（例v1,v2）
https://loveliuya.com/api/v1/

路径

路径是URL里面指出信息资源所在的文件目录或者文件名的部分，代表内容在服务器的位置。

每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

HTTP动词

对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面五个(括号里是对应的SQL命令)

GET ：从服务器获取资源
POST ：在服务器新建一个资源
PUT  ：在服务器更新资源（全部资源）
PATCH   ：在服务器更新资源（部分资源）
DELETE  ：从服务器删除资源
HEAD        ：获取资源的元数据
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的
过滤信息(Filtering)
如果记录数量很多，服务器不可能都将它们返回给用户，API应该提供参数，过滤返回结果。

下面是一些常见的参数

“?limit=10”：指定返回记录的数量
“?offset=10”：指定返回记录的开始位置。
“?page=2&per_page=100”：指定第几页，以及每页的记录数。
“?sortby=name&order=asc”：指定返回结果按照哪个属性排序，以及排序顺序。
“?animal_type_id=1”：指定筛选条件

状态码(Status Codes)

服务器向用户返回的状态码和提示信息，常见的有以下一些(方括号中是该状态码对应的HTTP动词)

- 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted ：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
- 401 Unauthorized ：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden ： 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND ：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR ：服务器发生错误，用户将无法判断发出的请求是否成功
- 503 Service Unavailable ：服务不可用

错误处理(Error handling)

有时我们会将表单内所有字段的验证错误信息一并返回给客户端：

{
	"code": 1001, //状态码
	"errors": [
		{ "name": "username", "error": "用户名不能为空" },
		{ "name": "password", "error": "密码不能少于6位" }
	]}
}

返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范

- GET /collection：返回资源对象的列表（数组）
- GET /collection/resource：返回单个资源对象
- POST /collection：返回新生成的资源对象
- PUT /collection/resource：返回完整的资源对象
- PATCH /collection/resource：返回完整的资源对象
- DELETE /collection/resource：返回一个空文档