Как описать в спецификации OpenApi поле DTO, которое является объектом, который лежит в другом пакете (не в DTO)?

Question

[javafrog]

Добрый день

Есть проект без OpenApi/Swagger-спецификации с описанными классами Model, Dto и др. в коде
Планирую описать спецификацию, чтобы по ней генерировались DTO-классы.
Описываю в Components классы DTO с полями.
Когда нужно описать поле, которое является объектом и лежит в том же пакете DTO, то пишу так:

UserDto
type: object
properties:
status:
$ref: '#/components/schemas/StatusDTO'

(и ниже в той же спеке у меня описан StatusDTO)

А как сделать ссылку (и можно ли) если одно из полей UserDto является объектом не DTO, а объектом из модели? Например, просто "Status" и лежит в другом пакете. Models.

Я пытался найти решение в документации OpenApi, но что-то не вышло. Нашел только ссылки на другие .yaml-файлы.
Версия OpenApi: 3.0.1

Answer 1

[Максим Федоров]

Когда нужно описать поле, <...>, то пишу так:

Если вы руками описываете, то руками и опишите модель вашу (статус ваш), и укажите ее через $ref

schemas:
     UserDto:
          type: object
          properties:
          status:
          $ref: '#/components/schemas/StatusModel'

     StatusModel: ~

Для yaml файла не важно название объектов и их иерархия/слои в коде — он работает в рамках своего стандарта и своей иерархии

Comments

[javafrog]

Мм.. ок. Я понял мысль. Спасибо!
Протестирую

Еще небольшой вопрос:
Если у меня в DTO описан был ( в коде) класс со вложенным/внутренним классом. Правильно ли я понимаю, что OpenApi не умеет генерировать DTO со вложенными классами?
И мне нужно вынести в принципе по архитектуре вложенный класс из DTO?

[Максим Федоров]

Floor is Java, а, я прошу прощения

Вы хотите OpenAPI связать с кодом своим? Тогда надо смотреть на документацию нужного решения, я думал вы просто руками заполняете

[javafrog]

Максим Федоров,
Да, есть код без документации. Описываю доку, чтобы по ней генерились ДТО+Контроллеры