Как определить повторно используемый параметр тела, который является примитивным типом данных в OpenAPI 3.0? - PullRequest
0 голосов
/ 09 ноября 2018

Я создаю спецификацию / описание API OpenAPI 3.0, в которой многие тела запросов содержат одни и те же параметры, и эти параметры представляют собой примитивные типы данных, такие как строки или целые числа. Например:

imei:
  type: integer
  format: int64
  description: 4G hardware device identifier

Я бы хотел определить эти параметры только один раз в объекте "компоненты", а затем использовать $ ref, чтобы включить их там, где это необходимо, вместо того, чтобы один и тот же параметр был определен в дюжине различных тел запросов. Я не смог найти способ сделать это.

  • Параметры, определенные в объекте «параметры», нельзя использовать в телах запросов. Облом. Я думаю, что это было разрешено в 2.0.
  • Я могу определить эти параметры в объекте «схемы», но Swagger Editor отобразит их в разделе «Модели». Довольно сложно назвать параметр, который является примитивным типом данных, моделью. Это параметры, которые используются в моделях, а не сами модели.

Я много искал в SO и в Интернете и не нашел ответа на этот конкретный вопрос. Возможно, ответ «это невозможно», но технический комитет OpenAPI может показаться недосмотром.

...