使用django rest framework 可以实现灵活接口开发;
Serializer 序列化器的使用:
因为此框架是django 的额外扩展,首先需要先下载才能使用
pip install djangorestframework
下载完毕后, 还需要在django 的settings.py 中添加rest_framework 应用:
INSTALLED_APPS = [
'rest_framework'
]
使用 Serializer 类 和 ModelSerializer 类进行序列化操作:
新建一个serializers.py 文件, 然后将rest_framework 中的 serializers 导入进来。
from rest_framework import serializers
class UserSerializers(serializers.Serializer):
name = serializers.CharField(read_only=True, max_length=255)
age = serializers.IntegerField(required=True)
gender = serializers.IntegerField(required=False)
address = serializers.CharField(required=True, max_length=255)
重要参数:
read_only: 仅支持 序列化输出,默认为 False, 例如: 通过orm 查询数据库, 得到的是一个QuerySet 对象, 通过序列化器, 将这些QuerySet 对象转化为Json 数据, 返回给前端, 但是 如果某个字段设置的read_only = True 的时候, 那么我们从前端拿到的json 数据, 反序列化为模型类对象并想将数据存入数据库的时候, 此字段会被忽略掉;
write_only: 与read_only 恰恰相反, 默认为False, write_only 仅仅为反序列化, 如果将其设置为True, 那么向前端返回序列化后的json 数据时, 设置此属性的字段会被忽略。
required: 是 Django REST Framework 序列化器中的一个选项,用于指定字段是否是必需的。当将字段标记为 required=True
时,这意味着在进行反序列化时,该字段是必须的,否则反序列化将失败并返回相应的错误信息。
接下来在视图中使用此序列化器:
class UserApiView(APIView):
def get(self, request):
users = UserModels.objects.all()
users_json = UserSerializers(users, many=True)
return Response(users_json.data)
当我们通过模型类查询出若有用户数据时, 得到的是一个QuerySet 对象, 然后调用序列化器, 将users 这个QuerySet 对象序列化为json 数据, 然后响应前端, users_json.data, 调用的这个data 属性就是已经序列化好的json 数据对象了。另外需要注意的是, 只有在传入QuerySet 对象的时候, 才将 many 这个参数设置为 True, 否则, 设置为False
ModelSerializer 序列化器的使用:
以上使用的 Serializer 类进行的序列化操作, 相对比较繁琐, 还有更简单的方式, 就是ModelSerializer 序列化器
在ModelSerializer 中, 使用 内部类 Meta 关联对应的模型类,极大的简化了开发流程
class UserModelSerializers(serializers.ModelSerializer):
class Meta:
model = UserModels
fields = "__all__" # 显示所有的字段