Django REST framework 基础用法详解：从配置到增删改查
本文详细介绍Django中REST framework的配置与使用。涵盖REST架构原则、URL设计规范、HTTP状态码含义，以及通过Serializers和ViewSets实现数据的增删改查操作。包含安装依赖、配置Settings、编写序列化器及视图类的完整步骤，并附Postman测试示例。
REST架构基础与核心概念
REST（Representational State Transfer）是一种软件架构风格，其核心思想是通过统一的接口对资源进行操作。
REST并非具体的协议或标准，而是Web应用应遵循的架构设计指导原则。
REST的全称是Representational State Transfer，中文译为“表现层状态转化”。
REST最显著的特征是面向资源。资源被视为服务器上一个可命名的抽象概念，通常以名词为核心进行组织，关注点在于名词本身。
REST规范要求通过统一的接口对资源执行操作，且每个资源仅允许执行一组有限的操作。
常用的HTTP方法包括：GET用于获取资源，POST用于新建资源（也可用于更新），PUT或PATCH用于更新资源，DELETE用于删除资源。
API设计规范与URL构建
API的设计需要遵循特定的规范，以确保接口的清晰性和一致性。
http://xxx.com/api/在RESTful架构中，每个URL代表一种资源（resource）。
URL中不应包含动词，只能包含名词，且名词通常与数据库中的表名相对应。由于数据库表通常存储记录的“集合”，因此API中的名词应使用复数形式。
例如，若API提供动物园（zoo）信息，包括动物和雇员数据，其路径设计应如下所示。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
HTTP请求方式决定了客户端与服务器之间的交互类型。
GET（SELECT）：从服务器取出资源（一项或多项）
POST（CREATE）：在服务器新建一个资源
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）
DELETE（DELETE）：从服务器删除资源
Filter过滤功能允许客户端对返回结果进行筛选和排序。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
状态码是服务端响应的一部分，用于指示请求的处理结果。
服务端返回的API响应中包含状态码（status codes），通过状态码可以判断请求是成功还是失败。
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。Django REST framework 配置与实现
以下是Django REST framework的具体实现用法。
为了更直观地测试API，建议下载并使用Postman工具，以便进行各种操作测试。
https://www.getpostman.com/apps环境安装与Settings配置
在使用前，需要先安装必要的模块。
pip install djangorestframework
pip install django-filter需要在Django的setting.py文件中添加相关配置参数。
INSTALLED_APPS中加入'rest_framework'，序列化器与视图类编写
在Django应用（app）中创建一个Python文件，用于定义序列化器（serializers）。
比如serializers.py然后写入restful
from rest_framework import serializers
from stu.models import Student（导入自己写的app、models）
class StudentSerializer(serializers.ModelSerializer):
class Meta:
# 关联数据表（前面不是变量名）
model = Student
# 确定需要序列化的字段（返回给用户的具体表中的字段）（前面不是变量名）
fields = ['id', 's_name', 's_tel']
def to_representation(self, instance):
data = super().to_representation(instance)
try:
# 得到关联表中的字段，必须用try,否则如果存在一个没有定义i_addr的学生时，系统将报错
data['s_addr'] = instance.studentinfo.i_addr
except Exception as e:
data['s_addr'] = ''
return data
在应用的views.py文件中创建视图类，处理业务逻辑。
from rest_framework import mixins,viewsets
from stu.serializers import StudentSerializer
from stu.models import Student
class StudentEdit(mixins.ListModelMixin,# 表示可以在Postman类似的软件中只能查找所有数据
viewsets.GenericViewSet,
mixins.RetrieveModelMixin, # 表示可以在Postman类似的软件中只能查找单一数据
mixins.UpdateModelMixin, # 表示可以在Postman类似的软件中更新数据
mixins.DestroyModelMixin, # 表示可以在Postman类似的软件中删除数据
mixins.CreateModelMixin): # 表示可以在Postman类似的软件中创建数据
# 查询所有信息
queryset = Student.objects.all()
# 序列化
serializer_class = StudentSerializer
URL路由配置与测试
创建URL路由配置，将视图与URL关联。
这里展示了URL配置的两种方式：可以直接写入urlpatterns，也可以使用+=运算符追加。
注意URL路径中不要以斜杠（'/'）结尾，Django会自动处理。
from stu import views
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
router.register(r'student', views.StudentEdit)
urlpatterns = [
# 其他url
]
urlpatterns += router.urls #这里表示添加定义的url
对应的方法实现了具体的增删改查逻辑。
在Postman中选择相应的参数并传入对应的URL即可执行操作。
增： POST http://127.0.0.1:8080/stu/addStu/1/
删： DELETE http://127.0.0.1:8080/stu/addStu/1/
改： UPDATE http://127.0.0.1:8080/stu/addStu/1/
查： GET http://127.0.0.1:8080/stu/addStu/1
在执行这些操作之前，必须先在views中定义好相关方法。
以上是对Django REST framework用法的详细解释，包括自带的增删改查功能，希望能对读者有所帮助。
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
