Detaillierte Erläuterung, wie Swaggerui im ​​Springboot verwendet wird

Stolzieren

Swagger ist eine sprachunabhängige Spezifikation und ein Framework, das zur Definition von Service-Schnittstellen verwendet wird, und wird hauptsächlich zur Beschreibung erholsamer APIs verwendet. Es konzentriert sich darauf, hervorragende Dokumentation und Client -Bibliotheken für APIs zu erstellen. Swagger-fähige APIs können interaktive Dokumente für API-Methoden generieren, sodass Benutzer die Funktionalität der API ermitteln können, indem sie visuell experimentieren, Anforderungen und Antworten, Header-Dateien und Rückgaberückgang anzeigen.

Swagger wird verwendet, um die API -Dokumentation zu definieren.

Nutzen:

1. Front- und hinterher separate Lieferung
2. Die API -Dokumentation ist sehr klar
3. Während des Tests müssen Sie keine URL -Eingabe mehr zum Browser verwenden, um auf den Controller zuzugreifen
4. Die traditionelle Art des Eintritts von URLs ist problematischer, um Parameter in Postanforderungen zu übergeben (natürlich können Sie Browser-Plug-Ins wie Postman verwenden).
5. Die Integration von Frühlingsboot und Prahlerei ist einfacher

Springboot bettet Swaggerui ein

Schritt

1.Jar Paket Einführung

 <De vorangestellt> <gruppe> io.springfox </GroupID> <artifactId> Springfox-Swagger-UI </artifactId> <version> 2.2.2 </Version> <Schops> kompilieren </scope> </abhängig> <Epaptid> <Grusupid> io.springfox </gruppen> <artifactId> </artifactid> </artifactid> <version> 2.2.2 </version> <Scope> kompilieren </scope> </abhängig>

2. Konfigurieren von SwaggerConfig basierend auf Springboot

 @Configuration @enableWagger2Public Class SwaggerConfig {@Bean public dockket newsapi () {// Neue Docket zurückgeben (documentationType.swagger_2) .APIInfo (apiInfo ()). Select (). Docket docket = new docket (documentationType.swagger_2); Docket.Enable (wahr); docket.apiInfo (apiinfo ()). select (). Pfade (pathSelectors.any ()). Build (); Rückgabedockt; } private apiInfo apiinfo () {Neue apiinfobuilder (). Titel ("Order Center -Testplattform"). Beschreibung ("Hier können Sie alle Schnittstellen des Projekts durchsuchen und relevante Testtools bereitstellen") .termsofServiceUrl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .Contact ("test") .License ("China Red Star Lizenz Version 1.0"). }}

3.. Webconfig -Konfigurationsanweisungen

Es gibt ein Problem, auf das hier geachtet werden muss. Lassen Sie WebConfig WebMVCAutoConfigurationAdapter erben, anstatt WebMVCConFigurerAdapter direkt zu erben, sonst wird die Swagger -Seite nicht veröffentlicht.

 @Configuration @enableWebmvcpublic class webconfig erweitert webmvcautoconfigurationAdapter {@Override public void addCorsMappings (CorsRegistry -Registrierung) {Registry.addmaping ("/**"); } @Bean Public static PropertySourCaSPlaceHoldConFigurer PropertySourCESPLACYMOLECONFIGURER () {Neue PropertySourcesPlacePlacePlaceConFigurer () zurückgeben; } @Bean public filter charakterencodingfilter () {CharakterCodingFilter charakterencodingFilter = new CharakterCodingFilter (); charakterencodingFilter.setEncoding ("utf-8"); charakterencodingFilter.setforceEncoding (true); Rückkehrcharakteritätsfilter; } @Bean public mapingjackson2httpMessageConverter Converter () {mapPingJackson2HttpMessageConverter Converter = new mapingjackson2HttpMessageConverter (); Rückwander; } @Bean public ViewResolver getViewResolver () {internalResourceViewResolver Resolver = new InternalResourceViewResolver (); Resolver.setViewClass (JSTLView.Class); Resolver.setPrefix ("/jsp"); Resolver.Setsuffix (". JSP"); Return Resolver; } @Bean public standardServletMultipartresolver getStandardardServletMultipArtresolver () {return neuer StandardsServletMultipartresolver (); }}

4.. Swaggerui Page Access

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

Das obige ist der gesamte Inhalt dieses Artikels. Ich hoffe, es wird für das Lernen aller hilfreich sein und ich hoffe, jeder wird Wulin.com mehr unterstützen.