Как я могу проверить, что моя документация Swagger действительна? - PullRequest
0 голосов
/ 14 сентября 2018

Для аннотаций Swagger очень просто отклониться от фактического кода.

Например

Я могу изменить возврат с Response.ok на Response.created и легко забыть обновитьаннотации от 200 до 201.

Или я мог бы изменить то, что является действительным, как нулевое или не нулевое, и конечный пользователь получит непонятные сообщения об отклонении, даже если его полезная нагрузка точно совпадает с тем, что говорится в документации.

Как проверить, соответствует ли моя документация по swagger тому, что делает мой код?

  • Тест, использующий селен и фантомы для анализа веб-страницы swagger-ui?
  • Отражение для анализааннотации?
  • Получить сгенерированный swagger.json и проанализировать его?
  • Что-то еще?

К сожалению, я не могу переключиться на Spring REST Docs.

1 Ответ

0 голосов
/ 17 июня 2019

Вы можете проверить следующую библиотеку , которая содержит несколько проектов, которые имеют дело с проверкой API.Я думаю, что тот, который вы ищете, называется "swagger-request-validator-mockmvc", но вы также можете найти другие библиотеки полезными.Удачи.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...