Многоразовый компонент вне компонентов / схемы?

Есть ли другое место для размещения многоразовых компонентов помимо components/schema?

У меня есть "частичный" (из-за отсутствия лучшего термина), который я хотел бы использовать для $ref в другом месте, но я не хочу его использовать в качестве "модели":

Несколько примеров:

NotFoundError:
  type: object
  properties:
    code:
      type: integer
      format: int32
      example: 404
    message:
      type: string
      example: "Resource Not Found"
ID-Array:
  type: array
  items:
    $ref: '#/components/schemas/ID'
  writeOnly: true
ID:
  type: integer
  format: int32
  example: 1
ID-ReadOnly:
  allOf:
    - $ref: '#/components/schemas/ID'
    - readOnly: true
ID-WriteOnly:
  allOf:
    - $ref: '#/components/schemas/ID'
    - writeOnly: true

swagger openapi

08.05.2018 17:28

Документирование API с помощью Swagger на Springboot

В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .

Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Возможное решение - поместить части в некоторый ключ расширения, скажем, x-partials, и соответственно изменить $ref. $ref не заботится о пути, пока цель находится в ожидаемом формате.

x-partials:
  ID:
    type: integer
    format: int32
    example: 1

components:
  schemas:
    ID-Array:
      type: array
      items:
        $ref: '#/x-partials/ID'
      writeOnly: true
    ID-ReadOnly:
      allOf:
        - $ref: '#/x-partials/ID'
        - readOnly: true
    ID-WriteOnly:
      allOf:
        - $ref: '#/x-partials/ID'
        - writeOnly: true

Таким образом, например, части не будут отображаться в разделе «Модели» пользовательского интерфейса Swagger.

08.05.2018 18:26

Другие вопросы по теме

Как определить свойство UUID в схеме JSON и открытом API (OAS)

OpenApi 3 импортирует схемы из внешних файлов

Используйте дискриминатор Swagger / OpenAPI, чтобы Джексон правильно сериализовал объект

При создании заглушки сервера python-flask не определены объекты модели

Как определить параметры заголовка в OpenAPI 3.0?

Как представить посторонние параметры Swagger

Использование openapi v3 с открытой свободой

Могут ли свойства и additionalProperties принимать нулевое значение в Swagger 2.0?

Как аннотировать тело запроса, относящееся к одной из внешних моделей?

Пользовательский интерфейс Swagger добавляет настраиваемые параметры curl

Многоразовый компонент вне компонентов / схемы?

Ответы 1

Другие вопросы по теме

Похожие вопросы