restful规范
@(python之路)[restful规范]
restful规范
什么是RESTful
- rest与技术无关，他只是代表代表一种架构风格，rest是representational state transfer的简称，中文翻译为“表征状态转移”；
- rest是从资源的角度来审视整个网络，它可以通过URL获取后端数据，前端做渲染，可以把后端看作为是一个资源；
- 面向自资源架构：ROA:Resource Oriented Architecture
RESTful API设计
1. api与用户的通信协议，最好使用HTTPs协议。
2.域名
尽量将API部署在专用域名但是这样做也会存在跨域风险。
第二种方式就比较简单了。
3.版本
我们api的版本最好是要标识出来，一般标识的地方，可以在域名中标；也可以在请求头标识。但是在跨域时会引发发送多次的请求头。
- url: 如：https://api.example.com/v1
- url: 如：https//www.example.com/api/v1
- 存放在请求头中。
4.路径，命名方式均使用名词表示（可以是复数）
method
- GET: 获取用户
- POST: 增加用户
- PUT:修改用户
- DELETE:删除用户
5.过滤，通过url上传参数的形式传递搜索条件
- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
6.状态吗
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
7.错误处理，状态码是4xx时，返回错误信息，error当作key
{
error:"Invalid API key",
}
8.返回结果，针对不同的操作，服务器应该向用户返回结果应符合以下规范。
GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档
9.Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}
