RESTful规范

通俗点讲其实就是写前后端分离项目的一个数据交互的规范，并没有强制性要求。

总共有十条，但是其中有三条非常重要！

一、API与用户的通信协议，总是使用HTTPs协议

因为http是明文显示的，数据不安全

二、域名要有区分

• https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
• https://example.org/api/                        API很简单（推荐*****）

 三、版本

• URL，如：https://api.example.com/v1/ 可以放在路径  （一般放在路径中）
• 请求头                                                  跨域时，引发发送多次请求

四、路径 视网络上任何东西都是资源，均使用名词表示（可复数）（*****）

• https://api.example.com/v1/zoos
• https://api.example.com/v1/animals
• https://api.example.com/v1/employees

请求路径上的资源都用名词表示如果删除新增都是一个名字也不符合逻辑，那就引出了method

五、通过method区分是什么操作 （*****）

• GET      ：从服务器取出资源（一项或多项）  查
• POST    ：在服务器新建一个资源　　  新增
• PUT      ：在服务器更新资源（客户端提供改变后的完整资源） 修改
• PATCH  ：在服务器更新资源（客户端提供改变的属性）  修改
• DELETE ：从服务器删除资源  删除

六、过滤，通过在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：指定筛选条件

路径中可以带上查询条件

七、状态码

状态码返回的是个json格式所以要定义一个字典比如{"status_code":100}，用JsonResponse返回

自己定义你的状态码，如果要有状态码的详情区分需要加上错误信息

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
复制代码

八、错误信息 应返回错误信息

{"status_code":100,‘msg‘:‘登录成功‘}
{"status_code":101,‘msg‘:‘用户名错误‘}

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

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

-get获取所有资源/get获取一个资源
-127.0.0.1/api/vi/books 获取所有图书
{"status_code":100,‘msg‘:‘获取成功‘,data:[{},{}]}
-127.0.0.1/api/vi/books/3 获取id为3的图书
{"status_code":100,‘msg‘:‘获取成功‘,data:{name：xx,....}}
-新增数据，把新增的数据再返回
-修改了数据，返回完整的资源对象
-删除数据，返回一个空文档

十、返回结果中提供连接

RESTful规范

原文：https://www.cnblogs.com/zhengyuli/p/11116565.html