Подробное объяснение того, как использовать Swaggerui в Springboot

Чванство

Swagger-это независимая от языка спецификация и структура, используемая для определения сервисных интерфейсов, и в основном используется для описания Restful API. Он фокусируется на создании отличной документации и клиентских библиотек для API. API-интерфейсы с поддержкой Swagger могут генерировать интерактивные документы для методов API, позволяя пользователям обнаружить функциональность API, экспериментируя визуально, просматривая запросы и ответы, файлы заголовков и коды возврата.

Swagger используется для определения документации API.

выгода:

1. Передняя и задняя часть отдельной доставки
2. Документация API очень ясна
3. Во время тестирования вам больше не нужно использовать вход URL в браузер для доступа к контроллеру
4. Традиционный способ ввода URL-адресов является более хлопотным для передачи параметров в запросах POST (конечно, вы можете использовать плагины браузера, такие как почтальон)
5. Интеграция пружины и чванства проще

Springboot встраивает Swaggerui

шаг

1. Ярский пакет введение

 <depervice> <groupid> io.springfox </groupid> <artifactid> springfox-swager-ui </artifactid> <serview> 2.2.2 </version> <scope> compile </scope> </arteyse> <deyedending> <groupid> io.springfox </artifactid> springfox> </ortifactd> </artifactid> </artifactid> <версия> 2.2.2 </version> <clacpope> compile </scope> </dependency>

2. Настройка SwaggerConfig на основе Springboot

 @Configuration @enabswager2public class swaggerconfig {@bean public docket newsapi () {// return new docket (documenttype.swager_2) .apiinfo (apiinfo ()). Select (). Paths (pathselectors.Any ()). Build (); Docket Docket = New Docket (documentType.swagger_2); docket.enable (true); docket.apiinfo (apiinfo ()). Select (). Paths (pathselectors.Any ()). Build (); вернуть Docket; } private apiinfo apiinfo () {return new apiinfobuilder (). title («Тестовая платформа центра заказа»). Описание («Здесь вы можете просмотреть все интерфейсы проекта и предоставить соответствующие инструменты тестирования») .termsofserviceurl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .contact ("test") .lisense ("China Red Star Лицензия версии 1.0"). Лицензион ("#"). Версия ("1.0"). }}

3. Инструкции по конфигурации WebConfig

Есть проблема, на которую здесь нужно обратить внимание. Пусть WebConfig наследует webmvcautoconfigurationAdapter вместо непосредственного наследства WebMVCConfigurerAdapter, в противном случае страница Swagger не будет выпущена.

 @Configuration @enablewebmvcpublic class webconfig extends webmvcautoconfigurationadapter {@override public void AddCorsMappings (Corsregistry Registry) {Registry.Addmapping ("/**"); } @Bean Public Static PropertySourcesplaceholderConfigurer PropertySourcesplaceholderConfigurer () {return New PropertySourcesplaceholderConfigurer (); } @Bean public filter parmentencodingfilter () {hareverencodingfilter ancervencodingfilter = new Matternencodingfilter (); HARCESENCODINGFILTER.SETENCODING ("UTF-8"); HARCESENCODINGFILTER.SETFORCEENCODING (TRUE); вернуть характерподингфильтер; } @Bean public maptingjackson2httpmessageconverter converter () {mappingjackson2httpmessageconverter converter = new MappingJackson2httpmessageConverter (); возвратный преобразователь; } @Bean public viewResolver getViewResolver () {InternalResourceViewResolver Resolver = new InternalResourceViewResolver (); resolver.setViewClass (jstlview.class); resolver.setPrefix ("/jsp"); resolver.setsuffix (". jsp"); вернуть резолвер; } @Bean Public STANDARDSVLETMULTIPARTRESOLVER GETSTANDARDSVLELMULTIPARTRESOLVER () {вернуть новые стандарты SNARDARDSVLETMULTIPARTRESOLVER (); }}

4. Доступ к странице Swaggerui

http: // localhost: 8080/projectName/swagger-ui.html#!//

Выше всего содержание этой статьи. Я надеюсь, что это будет полезно для каждого обучения, и я надеюсь, что все будут поддерживать Wulin.com больше.