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

Question

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

Answer 1

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

type: object
required:  # List the required properties here
  - name
properties:
  id:
    type: integer
    format: int64
  category:
    $ref: '#/definitions/Category'
  name:
    type: string
    example: doggie

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

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

# swagger: '2.0'

parameters:
  - in: body
    name: body
    required: true  # <----
    schema:
      $ref: '#/definitions/Pet'

# openapi: 3.0.1

requestBody:
  required: true  # <----
  content:
    ...

要指定可选字段的默认值，可以使用 default属性。下面是一个例子:

type: object
properties:
  huntingSkill:
    type: string
    description: The measured skill for hunting
    default: lazy