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

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

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

rest web-services xsd swagger openapi

04.05.2018 18:35

Стоит ли изучать PHP в 2026-2027 годах?

Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...

Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией

В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.

Приемы CSS-макетирования - floats и Flexbox

Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...

Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest

В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...

Концепция локализации и ее применение в приложениях React ⚡️

Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...

Пользовательский скаляр GraphQL

Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...

6 190

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

Ответы 2

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

Вы можете напрямую использовать объекты внешней схемы OpenAPI $ref, используя абсолютные или относительные 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 для получения дополнительной информации.

04.05.2018 20:16

Чтобы расширить ответ Хелен для тех, кто попадает сюда из Google, если Pet.yaml не является простым объектом, но имеет несколько таких объектов:

components:
  schemas:
    pet:
      type: object
      properties:
        (...)

Вы можете ссылаться на это так:

$ref: './common/Pet.yaml#/components/schemas/pet'

Но что, если я хочу включить документ вместо ссылки на документ? Есть разница. Я не хочу щелкать. Эта проблема также была решена в XML (XLink). Я надеялся увидеть что-то подобное в стандарте OpenAPI.

— 16.03.2020 09:01

06.01.2020 10:27