如何指定一个字段是可选还是需要在swagger中？

Question

如何在swagger中定义字段是可选还是必需的，默认值是什么？

Answer 1

默认情况下，模型中的字段是可选的，除非您将它们放在required属性中。下面是一个例子（ID，类别是可选字段）：

required: 
    - 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

为默认值，你可以简单地使用default属性。这里是一个例子：

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