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

Question

Я определяю общие схемы для веб-сервисов и хочу импортировать их в разделе компонентов / схемы спецификации. Я хочу создать каноническую модель данных, которая является общей для нескольких сервисов, чтобы избежать переопределения похожих объектов в каждом определении сервиса.

Есть ли способ сделать это? Существует ли механизм, аналогичный тому, что делает XSD со своим тегом импорта?

Answer 1

Вы можете $ref внешние объекты схемы OpenAPI напрямую, используя абсолютные или относительные URL:

responses:
  '200':
    description: OK
    schema:
      $ref: './common/Pet.yaml'
      # or
      # $ref: 'https://api.example.com/schemas/Pet.yaml'

где Pet.yaml содержит, например:

type: object
properties:
  id:
    type: integer
    readOnly: true
  petType:
    type: string
  name:
    type: string
required:
  - id
  - petType
  - name

См. Использование $ ref для получения дополнительной информации.