如何指定一個字段是可選還是需要在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