Django restful 规范

一、REST Frame Work

• REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

• REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态

• REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

• 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性

• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

 

二、restful 规范 接口设计

 

1. API与用户的通信协议，总是使用HTTPs协议。（楼主穷 HTTP协议）

2. 域名
   https://api.example.com 尽量将API部署在专用域名（跨域问题、会发送二次请求）
   https://yuan.cn/api/ 建议使用这样的省钱、简单的API设计

3. 版本
   URL，如：https://api.example.com/v1/

4. 请求头 跨域时，引发发送多次请求

5. 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
   https://api.example.com/v1/zoos
   https://api.example.com/v1/animals
   https://api.example.com/v1/employees

6. method
   GET ：从服务器取出资源（一项或多项）
   POST ：在服务器新建一个资源
   PUT ：在服务器更新资源（客户端提供改变后的完整资源）（全部更改）
   PATCH ：在服务器更新资源（客户端提供改变的属性）（用户可能只需要改其中的一部分，如密码、密保问题、邮箱这样，不需要全部更改）
   DELETE ：从服务器删除资源

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