Генерация клиента Swagger с помощью Spring REST Docs
Я видел эту весну REST Docs - видео
Мы делаем загрузочные проекты Spring и используем библиотеку springfox для генерации документации Swagger-ui и swagger, как описано здесь
Нам нравится то, что документы Spring Rest могут сделать для создания документации по REST API, и тот факт, что нам не нужно добавлять аннотации типа swagger, такие как @ApiResponse или @ApiOperation, в нашем коде контроллера. А также тот факт, что документация теперь живет с кодом.
Но если мы пойдем с документами Spring Rest, мы упустим Swagger-UI, который автоматически генерируется для нашего API (когда мы используем интеграцию Swagger).
Может ли Spring REST docs генерировать тестовый интерфейс, такой как Swagger UI.
1 ответ
Этот проект генерирует спецификацию OpenAPI из Spring REST Docs.
Это прямо противоречит идее дизайна и намерениям Spring REST Docs. Одна из основных целей этого заключается в том, чтобы документы были привязаны к модульным тестам, поэтому вы знаете, что ваша документация надежна, даже когда вы вносите изменения в логику или подпись в свой контракт REST.
Кроме того, в качестве видео, на которое вы ссылались, приведено несколько примеров того, как автоматическая генерация документов приводит к нежелательному выводу.
Поэтому выбор состоит в том, чтобы проделать большую работу, чтобы получить намного лучшие документы, или сделать полностью автоматизированный вариант, чтобы сэкономить время и получить работоспособные, но менее качественные документы. Это то, что когда-либо ваш приоритет.