По умолчанию поля в модели являются необязательными, если вы не поместите их в список 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
Если это модель запроса body, вам, вероятно, также нужно будет пометить тело как 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