如何在OpenAPI/Swagger中指定字段是可选的还是必需的?
如何在OpenAPI/Swagger中定义字段是可选的还是必需的,默认值是多少?默认情况下,模型中的字段是可选的,除非您将其放入如何在OpenAPI/Swagger中指定字段是可选的还是必需的?,swagger,openapi,Swagger,Openapi,如何在OpenAPI/Swagger中定义字段是可选的还是必需的,默认值是多少?默认情况下,模型中的字段是可选的,除非您将其放入必需的列表中。下面是一个示例-id,category是可选字段,name是必需的。请注意,required不是字段的属性,而是对象本身的属性-它是必需属性的列表 类型:对象 必需:#在此处列出必需的属性 -名字 特性: 身份证件: 类型:整数 格式:int64 类别: $ref:“#/定义/类别” 姓名: 类型:字符串 例子:小狗 参考: 如果这是请求主体的模型,您可
必需的列表中。下面是一个示例-id
,category
是可选字段,name
是必需的。请注意,required
不是字段的属性,而是对象本身的属性-它是必需属性的列表
类型:对象
必需:#在此处列出必需的属性
-名字
特性:
身份证件:
类型:整数
格式:int64
类别:
$ref:“#/定义/类别”
姓名:
类型:字符串
例子:小狗
参考:
如果这是请求主体的模型,您可能还需要将主体本身标记为必需的:
#大摇大摆地说:“2.0”
参数:
-在:身体
姓名:body
必需:除非标记为必需,否则true#字段是可选的
您可以列出如下所示的必填字段:
SomeObject:
type: object
required:
- name
- fartingPower
properties:
name:
type: string
fartingPower:
type: integer
另一种语法:
Response:
type: object
required: [id, title]
properties:
id:
type: string
title:
type: string
光是放屁的力量就应该得到+1
Response:
type: object
required: [id, title]
properties:
id:
type: string
title:
type: string