如何在 OpenAPI/Swagger 中指定字段是可选的还是必需的?

如何在 OpenAPI/Swagger 中定义字段是可选的还是必需的，默认值是什么?

How to I define in OpenAPI/Swagger if a field is optional or required and what is the default?

默认情况下，模型中的字段是可选的，除非您将它们放在 required 列表中.下面是一个示例 - id、category 是可选字段，name 是必需的.请注意，required 不是字段的属性，而是对象本身的属性 - 它是必需属性的列表.

By default, fields in a model are optional unless you put them in the required list. Below is an example - id, category are optional fields, name is required. Note that required is not an attribute of fields, but an attribute of the object itself - it's a list of required properties.

参考:https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L658

如果这是请求正文的模型，您可能还需要将正文本身标记为required:

If this is the model for the request body, you'll probably also need to mark the body itself as required: