Проверить спецификацию Swagger 2.0 в сборке Maven?

Я следую первоочередному подходу к созданию REST API в стеке Java/Spring MVC.

У меня есть написанная от руки схема Swagger, которую я хочу проверить в своей сборке Maven, и я хочу, чтобы эта сборка завершилась ошибкой, если схема не соответствует спецификации схемы Swagger.

Я пытался сделать это, используя swagger-codegen для создания статической документации; но 1) это не ошибки, которые ловит swagger-editor; и 2) результат невелик (но это не относится к делу ;-)).

Кто-нибудь решил эту проблему удовлетворительно самостоятельно?


maven rest swagger swagger-editor
person Ben Fowler    schedule 10.03.2016    source источник
comment
Много ли изменит этот написанный от руки документ Swagger? Почему вы не можете просто проверить его в swagger-editor после его изменения?   -  person Navid Shakibapour    schedule 11.03.2016
comment
Мысль пришла мне в голову, но да, это изменится, поэтому я хочу гарантировать, что это не сломается, путем принудительных проверок в сборке. Вот мой общий подход: bjf-codebrown .blogspot.co.uk/2016/03/   -  person Ben Fowler    schedule 11.03.2016
comment
Хорошая статья! Я хотел предложить assertj-swagger, но увидел, что он уже упоминается в вашей статье.   -  person Navid Shakibapour    schedule 14.03.2016
comment
@NavidShakibapour: спасибо! Кроме того, я внес свой вклад в assertj-swagger, чтобы решить некоторые проблемы, которые у меня были.   -  person Ben Fowler    schedule 14.03.2016

Ответы (1)


arrow_upward
1
arrow_downward

Вы можете создать дополнительный шаг в своей системе сборки Maven для проверки документа Swagger на соответствие Схема Swagger 2.0.

Я создал пример проекта Maven, который проверяет документы JSON swagger в разделе /src/main/resources/swagger.

Вы можете клонировать проект здесь: https://github.com/navidsh/maven.swagger.validator< /а>

person Navid Shakibapour    schedule 14.03.2016