swagger 2 spring boot generate yml file

Question

Я новичок в чартах, контрактах и ​​работе над проектом Spring boot (gradle), где мы только начинаем работать с контрактами. Я использовал grails, люблю, как вы можете поместить поле defs в Домен, и он унаследован через стек.

Конкретный вопрос и, возможно, вопрос с копией, связанный с копией.

Как я могу создать основной заглушка YAML-файла из стандартного класса контроллера?

Я понимаю, что я должен создать [Имя] -v1-0.yml файл в каталоге controller\src\test\resources

Я реализованный чванство-ui.html в проекте и действительно крутой интерактивный появляется веб-страница с указанием конечных точек запроса и материалов. Использование class SwaggerConfig extends WebMvcConfigurerAdapter, который работает для публикации интерфейсов на веб-странице ui json doc.

Я считаю, что понимание заключается в том, что файл yml в каталоге тестовых ресурсов будет фиксированным поколением «контрактов» и используется в каком-то методе проверки градиента, чтобы убедиться, что подпись API и точки контракта не изменились, как базовый тест стиля юнита интерфейса. (Да/нет?)

Я ленив, думая про себя, почему я ручаю взломать этот глупый файл? Может ли скелет документа yaml doc сгенерировать для меня довольно легко из деталей контроллера/модели?

Например, на странице принимает файл YML и делает пользовательский интерфейс для печати: http://editor.swagger.io/#/

Там действительно хороший «убер» YAML файл образца в этой странице, мне действительно нужно писать, что я уже написал Контроллер, javadoc, аннотированный, всевозможные классные вещи, которые должны были бы создать по крайней мере довольно хороший стартовый барабан yaml (я обвиняю вас в том, что вы не хотите взломать это!), прежде чем, конечно, добавьте аннотации SpringFox которые делают больше прохладных продуктов и действительно собираются в город, чтобы стимулировать эту проверку контрактов на испытания.

FYI: 'spring-boot-starter-web' 'spring-boot-starter-test' 'springfox-swagger-ui', version: '2.4.0'

Answer 1

Я получил его. Очень просто, почему я этого нигде не видел. :)

Копировать/вставить путь ресурса в браузере:

http://localhost:8095/v2/api-docs?group=full-api

Выберите сгенерированный контент и скопировать в буфер обмена.

Открыть Кураж редактор в браузере:

http://editor.swagger.io

Выберите Вставить JSON ... из меню Файл.

Вставьте созданный контент JAON Swagger и нажмите «Импорт».

Answer 2

Существует запрос особенность, чтобы обеспечить YAML представление спецификации: https://github.com/springfox/springfox/issues/651

Помимо прогресса, он пока не доступен