前言

在使用 django-rest-framework 开发接口的时候，我们希望能设置有些字段是必填字段，有些字段是非必填字段。
在使用ModelSerializer 序列化的时候，可以个字段加一个 required 参数设置 True 或 False 。

ModelSerializer 序列化

接着前面一篇,设置日期时间格式后，发现这2个字典是必填项了

from rest_framework import serializers

class GoodsAPISerializer(serializers.ModelSerializer):
    # 设置创建时间和更新时间格式化
    create_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S')
    update_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S')

    class Meta:
        model = Goods
        fields = '__all__'  # 返回全部的字段

提交数据后返回 create_time 和 update_time 是必填项

{
    "code": 3003,
    "msg": "参数不合法",
    "data": {
        "create_time": ["该字段是必填项。"],
        "update_time": ["该字段是必填项。"]
    }
}

设置非必填项 required=False

如果我们想设置某个字段是非必填项，在ModelSerializer序列化的时候，只需加一个参数 required=False

from rest_framework import serializers
# 作者-上海悠悠 QQ交流群:717225969
# blog地址 https://www.cnblogs.com/yoyoketang/

class GoodsAPISerializer(serializers.ModelSerializer):
    create_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', required=False)
    update_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', required=False)

    class Meta:
        model = Goods
        fields = '__all__'  # 返回全部的字段

接下来再提交数据的时候，就不用传 create_time 和 update_time 参数了

设置必填项 required=True

我们也可以设置其他字段是必填项，在ModelSerializer序列化的时候，只需加一个参数 required=True

from rest_framework import serializers
# 作者-上海悠悠 QQ交流群:717225969
# blog地址 https://www.cnblogs.com/yoyoketang/

class GoodsAPISerializer(serializers.ModelSerializer):
    create_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', required=False)
    update_time = serializers.DateTimeField(format='%Y-%m-%d %H:%M:%S', required=False)

    # 设置必填项
    stock = serializers.IntegerField(required=True)

    class Meta:
        model = Goods
        fields = '__all__'  # 返回全部的字段

接下来提交数据的时候，不带 stock 字段就会提示：该字段是必填项。

{
    "code": 3003,
    "msg": "参数不合法",
    "data": {
        "stock": ["该字段是必填项。"]
    }
}

2021年第六期《python接口自动化+测试开发》课程，1月9号开学（火热报名中！）

本期上课时间：1月9号-4月18号，每周六、周日晚上20:30-22:30

本站仅提供存储服务，所有内容均由用户发布，如发现有害或侵权内容，请点击举报。