结合DRF框架提供标准RESTful API接口
https://www.cnblogs.com/xiaonq/p/10053234.html
restful说明
1、RESTful不是一种技术,而是一种接口规范,主要规范包括:1.请求方式、2.状态码、3、url规范、4、传参规范
2、RESTful核心是面向资源编程
·把所有数据都当做一个资源,在url中使用名词或者名词的复数形式表示这个资源
·以 get/post/put/delete 请求方式,来区别他们的增删改查动作
请求方式method
GET :从服务器取出资源(一项或多项)
POST :在服务器新建一个资源
PUT :在服务器更新资源(客户端提供改变后的完整资源)
PATCH :在服务器更新资源(客户端提供改变的属性)
DELETE :从服务器删除资源
状态码
、、、0.1xxx 接受,继续处理
100 (继续) 请求者应当继续提出请求。 服务器返回此代码表示已收到请求的第一部分,正在等待其余部分。
101 (切换协议) 请求者已要求服务器切换协议,服务器已确认并准备切换。
'''1. 2XX请求成功''' #----- 200 请求成功,一般用于GET与POST请求 #----- 201 Created - [POST/PUT/PATCH]:用户新建或修改数据成功。 # 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) # 204 NO CONTENT - [DELETE]:用户删除数据成功。 '''2. 3XX重定向''' #----- 301 NO CONTENT - 永久重定向 #----- 302 NO CONTENT - 临时重定向 '''3. 4XX客户端错误''' # 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] 当创建一个对象时,发生一个验证错误。 '''4. 5XX服务端错误''' #----- 500 INTERNAL SERVER ERROR - [*]:服务器内部错误,无法完成请求 # 501 Not Implemented 服务器不支持请求的功能,无法完成请求
面向资源编程: 路径,视网络上任何东西都是资源,均使用名词表示(可复数)
所有请求实际操作的都是数据库中的表,每一个表当做一个资源 资源是一个名称,所以RESTful规范中URL只能有名称或名词的复数形式 https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
过滤,通过在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:指定筛选条件