python測試開發django-rest-framework-85.序列化(ModelSerializer)之設置必填（required）和非必填字段

前言

在使用 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": ["該字段是必填項。"]
	}
}