Swagger UI - вызов параметров из компонентов

Question

Я использую Swagger UI с изображением докера Swaggerapi / Swagger-UI.Я пытаюсь использовать параметры, определенные в компонентах в одном из моих путей, но это не работает.В чем проблема?

В моем файле index.yaml

components:
  ...
  parameters:
    Pagination:
    - in: query
      name: page
      schema:
        type: integer
        required: false
      description: The page to go to
    - in: query
      name: per_page
      schema:
        type: integer
        required: false
      description: The number of items per page
  ...

В моем файле пути

parameters:
  $ref: '../index.yaml#/components/parameters/Pagination'

Спасибо за любую помощь

Answer 1

OpenAPI позволяет вам $ref отдельные параметры, но не группу параметров.Поэтому, если у вас есть несколько общих параметров, вам необходимо создать для них отдельные определения в разделе components/parameters.Кроме того, required является атрибутом параметра, а не атрибутом схемы:

components:
  parameters:
    pageParam:          # <-----
      in: query
      name: page
      schema:
        type: integer
      required: false   # <-----
      description: The page to go to
    perPageParam:       # <-----
      in: query
      name: per_page
      schema:
        type: integer
      required: false   # <-----
      description: The number of items per page

Затем в файле пути используйте:

parameters:
  - $ref: '../index.yaml#/components/parameters/pageParam'
  - $ref: '../index.yaml#/components/parameters/perPageParam'