zoukankan      html  css  js  c++  java
  • 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": ["该字段是必填项。"]
    	}
    }
    
  • 相关阅读:
    前端笔记(关于解决打包时报node-sass错误的问题)
    前端笔记(Echarts学习总结)
    前端笔记(近期整理的一些开发备注)
    代码(css3向下箭头指引)
    Hexo 博客利用 Nginx 实现中英文切换
    prefetch 和 preload 及 webpack 的相关处理
    利用 Github 网络钩子实现自动化部署
    使用 Nginx 实现 301 跳转至 https 的根域名
    作为 attribute 和 property 的 value 及 Vue.js 的相关处理
    使用 Vue.js 改写 React 的官方教程井字棋
  • 原文地址:https://www.cnblogs.com/yoyoketang/p/14291206.html
Copyright © 2011-2022 走看看