Django—DRF框架

2023-11-15 18:27:52

一、RESTfull设计风格

1、首先，rest就是Representational State Transfer的缩写。rest与技术无关只是一种软件架构风格，rest从资源角度审视整个网络，所有的数据无论是从网络获取还是操作的数据，都是资源。将一切数据视为资源是rest区别于其他架构最本质的属性，每一个URL代表一种资源，客户端通过HTTP动词对服务器进行操作，实现“表现层状态转化”（get，post，put，delete）

2、restfull的设计规范

（1）域名

1）子域名方式

　　　　　　https://api.example.com 尽量将API部署在专用域名（会存在跨域问题）

　　　　　　https://www.example.com

　　　　2）url方式

　　　　　　https://example.org

　　　　　　https://example.org/api/ API很简单

（2）版本

将API的版本号放入URL中。

　　　　https://api.example.com/v1/

　　　　https://api.example.com/v2/

（3）路径

路径又称“终点”，表示API的具体网址，每个网址代表一种资源

　　　　1）资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。

　　　　2）API中的名词应该使用复数。无论子资源或者所有资源。

　　　　　　/getProducts　　　　不符合REST风格

　　　　　　/Orders 　　　　　　符合REST风格

　　　　　　获取单个产品：http://127.0.0.1:8080/AppName/products/1

　　　　　　获取所有产品：http://127.0.0.1:8080/AppName/products

（4）方式

GET ：从服务器取出资源（一项或多项）

　　　　　　POST ：在服务器新建一个资源

　　　　　　PUT ：在服务器更新资源（客户端提供改变的完整资源）

　　　　　　PATCH ：在服务器更新资源（客户端提供改变的属性）

　　　　　　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）状态码

'''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     服务器不支持请求的功能，无法完成请求

（7）异常处理

如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。{ error: "Invalid API key" }

（8）返回结果

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

　　　　　　　　GET /collection：返回资源对象的列表（数组）

　　　　　　　　GET /collection/resource：返回单个资源对象

　　　　　　　　POST /collection：返回新生成的资源对象

　　　　　　　　PUT /collection/resource：返回完整的资源对象

　　　　　　　　PATCH /collection/resource：返回完整的资源对象

　　　　　　　　DELETE /collection/resource：返回一个空文档

二、DRF框架的使用（Django REST Framework）

Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。通常简称为DRF框架或 REST framework。是一套基于Django开发的Django工具包,依赖python和Django，用于在Web后台构建Restful接口。其特点：

提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
提供了丰富的类视图、Mixin扩展类，简化视图的编写；
可扩展性，插件丰富

安装DRF

pip install djangorestframework

配置DRF

INSTALLED_APPS = ['rest_framework']

序列化器定义：

　　创建一个serializer.py文件，导入包 from rest_framework.serializers import ModelSerializer

码农公寓

一、RESTfull设计风格

二、DRF框架的使用（Django REST Framework）

相关文章