Django rest framework + drf-yasg 关于 api 文档 web 页面数据修改方法

Posted 2023-02-23

参考技术A operation_summary ：操作名称如下图

operation_description ：接口介绍 如下图

operation_id ：操作方法名如下图

manual_parameters : 修改 Parameters 中参数说明

request_body ：post 发送内容 如下图

responses ：响应内容 如下图

enum : 定义改字段可选的参数值，默认写第一个。如下图

description : 字段描述
type : 字段需要什么类型的数据
             TYPE_OBJECT = "object"
             TYPE_STRING = "string"
             TYPE_NUMBER = "number"
             TYPE_INTEGER = "integer"
             TYPE_BOOLEAN = "boolean"
             TYPE_ARRAY = "array"
             TYPE_FILE = "file"

format : 进行验证的方式
             FORMAT_DATE = "date"
             FORMAT_DATETIME = "date-time"
             FORMAT_PASSWORD = "password"
             FORMAT_BINARY = "binary"
             FORMAT_BASE64 = "bytes"
             FORMAT_FLOAT = "float"
             FORMAT_DOUBLE = "double"
             FORMAT_INT32 = "int32"
             FORMAT_INT64 = "int64"
             FORMAT_EMAIL = "email"
             FORMAT_IPV4 = "ipv4"
             FORMAT_IPV6 = "ipv6"
             FORMAT_URI = "uri"
             FORMAT_UUID = "uuid"
             FORMAT_SLUG = "slug"
             FORMAT_DECIMAL = "decimal"