RestFramework——API设计规范
what's the RESTful
RestFramework是⼀个能快速为我们提供API接⼝，⽅便我们编程的框架。API是后端编程⼈员写的，为了让前端拿数据的⼀个接⼝，通常就是以url的形式存在。
每个项⽬总有第⼀个⼈做基础构架，这个时候就不是仅仅实现⼀个API就OK了，需要考虑更多的事情，包括
统⼀的异常处理
API权限
统⼀的参数校验
缓存如何可以做的更简单统⼀
认证
统⼀的查询过滤
代码分层
RestFramework能很好的帮我们做这些事情。
了解RestFramework之前我们⾸先要知道什么是REST：
REST是⼀种标准，restful是⼀种规范，根据产品需求需要定出⼀份⽅便前后端的规范，与协议（如HTTP协议）不同，不是所有的标准要求都需要遵循。
REST与技术⽆关，代表的是⼀种软件架构风格，REST是Representational State Transfer的简称，中⽂翻译为“表征状态转移”
REST从资源的⾓度类审视整个⽹络，它将分布在⽹络中某个节点的资源通过URL进⾏标识，客户端应⽤通过URL来获取资源的表征，获得这些表征致使这些应⽤转变状态
所有的数据，不过是通过⽹络获取的还是操作（增删改查）的数据，都是资源，将⼀切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种⾯向资源的架构风格，有⼈提出⼀种全新的结构理念，即：⾯向资源架构（ROA：Resource Oriented Architecture）
API设计规范
⾸先我们要知道，API并不是必须的，如果整个项⽬只有你⼀个⼈或者很少的⼈完成，完全可以直接⽤Django的模板引擎渲染发送到前端后直接操作。API的使⽤主要是为了解决多⼈开发，特别是前后端分离的情况。因为前端⼈员在制作页⾯时必然会需要向后端要数据，但是假如前后端是分离的，就不能⽤Django的render了，⼤部分情况前端会⽤ajax发送请求，后端⼈员则发送JSON字符串给前端，前端再反序列化后进⾏使⽤。这个时候其实我们设计⼀套API出来，就能使我们的任务轻松很多。所以，RestFramework就应运⽽⽣了。
API与⽤户的通信协议，本质上是HTTPs协议。
使⽤RestFramework设计API有⼀套规范，即RESTful，为了不平添与你合作开发的⼈的烦恼，我们还是要遵循这些规范。那么到底有哪些规范呢？
1. 域名：域名上要显⽰你使⽤了API，我们有两种⽅式
ample ⽅式⼀：将API部署在专⽤域名上（是官⽹的推荐⽅式，但这么做会存在跨域问题）
/api/ ⽅式⼆：写在路径上，API很简单
2. 版本：我们的项⽬在开发过程中会进⾏功能的添加及优化，这个时候我们通常会为每⼀个版本设定⼀个版本号，版本号的显⽰也有两
种⽅式
ample/v1/ ⽅式⼀：写在路径上，API很简单
v1.example ⽅式⼆：将版本号部署在专⽤域名上（同样会存在跨域问题，跨域时会引发发送多次请求）3. 路径：视⽹络上任何东西都是资源，所以路径均使⽤名词表⽰（可复数）
ample/v1/zoos
ample/v1/animals
4. 请求⽅式：
GET ：从服务器取出资源（⼀项或多项）
POST ：在服务器新建⼀个资源
PUT ：在服务器更新资源（客户端提供改变后的完整资源——全部修改）
PATCH ：在服务器更新资源（客户端提供改变的属性——部分修改）
DELETE ：从服务器删除资源
5. 过滤：通过在URL上传参的⽅式，有GET请求获取相应的数据
ample/v1/zoos?limit=10：指定返回数据的数量
ample/v1/zoos?offset=10：指定返回数据的开始位置
ample/v1/zoos?page=2&per_page=100：指定第⼏页以及每页的数据数量
ample/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
ample/v1/zoos?animal_type_id=1：指定筛选条件
6. 状态码：我们可以通过状态码来判断请求的状态，以处理相应的请求。在状态码是4开头时，应该捕捉相应错误并返回错误信息
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 - [*]：服务器发⽣错误，⽤户将⽆法判断发出的请求是否成功。
更多看这⾥：/Protocols/rfc2616/rfc2616-sec10.html
api设计常⽤状态码
{error: "Invalid API key"}#错误信息因⽤error作为key
7. 返回结果：针对不同操作，服务器向⽤户返回的结果应该符合以下规范。
GET/collection：返回资源对象的列表
GET/collection/resource：返回单个资源对象
POST/collection：返回新⽣成的资源对象
PUT/collection/resource：返回完整的资源对象
PATCH/collection/resource：返回完整的资源对象
DELETE/collection/resource：返回⼀个空⽂档
8. Hypermedia API：RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API⽅法，使得⽤户不查⽂档，也知道下⼀
步应该做什么。
{"link": {
"rel": "collection ample/zoos",
"href": "ample/zoos",
"title": "List of zoos",
"type": "urformat+json"
}}
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论