Должно ли свойство объекта string представлять число быть строкой или числом - PullRequest
0 голосов
/ 29 января 2020

Как указано в заголовке, моя команда всегда отправляет ответ о том, какие свойства представляют float / int / bigInteger в виде строк. Должен ли тип swagger этих свойств быть числом или строкой?

1 Ответ

1 голос
/ 29 января 2020

Тип данных в определении OpenAPI должен указывать фактический тип данных, используемый в полезной нагрузке.

Если ответом является

{
  "id": "12345"
}

, тогда id является свойством type: string .

Вы можете использовать format и pattern (шаблон регулярных выражений) для уточнения формата значения. Например, если id строки содержат неотрицательные целые числа, вы можете определить id как:

type: string
pattern: "^\\d+$"
...