一、安装环境
pip install djangorestframework
pip install django-filter
二、创建一个API实现对数据库的增删改查
1.配置INSTALLED_APPS
把rest_framework添加在INSTALLED_APPS模块中
INSTALLED_APPS = [
# 在此处添加
'rest_framework',
]
2.配置url
此处配置url地址时需要注意的是正则表达式中不需要添加"/" ，此处会自动添加。绑定的StudentEdit是类而不是方法。
from rest_framework.routers import SimpleRouter
# 实例化 简单路由
router = SimpleRouter()
router.register(r'^student', views.StudentEdit)
urlpatterns += router.urls
3.创建views
mixins.ListModelMixin 查询全部记录；
mixins.RetrieveModelMixin 查询某一条记录；
mixins.UpdateModelMixin 更新一条记录；
mixins.DestroyModelMixin 删除一条记录；
mixins.CreateModelMixin 增加/创建一条记录。
class StudentEdit(mixins.ListModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.CreateModelMixin,
viewsets.GenericViewSet):
# 查询所有信息
queryset = Student.objects.all()
# 序列化
serializer_class = StudentSerializer
4.创建类
新建一个py文件，通常命名为serializer.py，在这个文件中创建一个类，继承serializers.ModelSerializer类，fields指定返回的字段，如果需要返回的字段还有其他表中的字段，可通过重写to_representation方法，把需要的字段加入返回的数据中。
from rest_framework import serializers
from stu.models import Student
class StudentSerializer(serializers.ModelSerializer):
class Meta:
# 指定数据库
model = Student
# 指定从数据库返回的字段
fields = ['id', 's_name', 's_tel']
def to_representation(self, instance):
# 序列化 instance 表示实例
data = super().to_representation(instance)
try:
# 如果数据库中 i_addr 值为空，会发生异常，可以进行异常处理
data['i_addr'] = instance.studentinfo.i_addr
except Exception as e:
data['i_addr'] = ''
return data
5.实现效果
a.通过地址：xxxx/student/ 可获取全部学生信息
image.png
b.通过地址：xxxx/student/id/ 获取指定学生的信息
image.png
c.修改指定学生的信息
步骤b的操作可以搜索出指定学生的信息，在页面上可以看到如下内容：
image.png
直接输入修改的内容，点击put，即修改成功
d.删除指定学生的信息
步骤b的操作搜索指定的学生，点击页面DELETE按钮，即可删除该条记录
image.png
三、自定义数据返回结构
页面默认返回的msg结构如下：
image.png
很显然这并不是我们想要的结构，那么我们可以通过下面的方式重新定义返回结构。
1.继承JSONRenderer类，重构render方法
from rest_framework.renderers import JSONRenderer
class CustomJsonRenderer(JSONRenderer):
def render(self, data, accepted_media_type=None, renderer_context=None):
"""
格式
{
'code': xxx,
'msg': 请求成功,
data: {返回数据}
}
"""
if renderer_context:
if isinstance(data, dict):
# pop（参数1，参数2） 若参数1不存在，默认取参数2的值
msg = data.pop('msg', '请求成功')
code = data.pop('code',0)
else:
msg = '请求成功'
code = 0
response = renderer_context['response']
response.status_code = 200
res = {
'code': code,
'msg': msg,
'data': data
}
return super().render(res, accepted_media_type, renderer_context)
else:
return super().render(data, accepted_media_type, renderer_context)
2.配置setting.py
'utils.RenderResponse.CustomJsonRenderer'是重构的render方法所在的文件路径
# 配置restful api 返回结果
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'utils.RenderResponse.CustomJsonRenderer',
)
}
3.设置错误提示信息
在StudentSerializer类中设置错误提示信息后，当用户发出patch、post等请求时，若用户提交的数据不符合我们规定的数据要求，可以返回提示信息，但默认的提示信息是英文，我们可以根据项目需求修改为我们想要的内容。
如下：设置当用户名为空时，返回错误信息：用户名不能为空；当用户名超出规定的最大长度时，返回错误信息：用户名太长了。当电话号码为空时，返回错误信息：电话不能为空；当电话号码长度小于11或大于11时，都返回错误信息：电话号码必须为11位。
# 设置错误提示信息
s_name = serializers.CharField(error_messages={
'blank': '用户名不能为空',
'max_length': '用户名太长了'
}, max_length=10)
s_tel = serializers.CharField(error_messages={
'blank': '电话不能为空',
'max_length': '电话号码必须为11位',
'min_length': '电话号码必须为11位'
}, max_length=11, min_length=11)
点击CharField，查看fields.py文件，文件中CharField类中有四个错误提示值：
invalid 无效值；blank 值为空；max_length 值的最大长度；min_length 值的最小长度。当发生上面四种错误时，就会返回这个错误对应的内容，我们可以对这个内容进行修改。
image.png
网友评论