Wenn Ihr Unternehmen Swagger nicht benutzt oder sogar von Prahlerei gehört hat, beeilen Sie sich und lernen Sie diesen Blog, fünf Minuten schnelle Integration im Narren Stil, aber eine so einfache Anwendung wird sie sicherlich schockieren.
Lassen Sie uns zunächst eine kurze Einführung in Swagger: Swagger geben ein magisches Werkzeug für die Back-End-Entwicklung und einen Kanal für die Front-End-Kommunikation. Was können Sie mit Prahlerei machen? Zunächst können Sie sich im Grunde genommen von den Tests der Einheit in der Zukunft verabschieden. Zweitens müssen Sie keine Schnittstellendokumente mehr schreiben und die Dokumente nach dem Schreiben nicht verwalten. Swagger kann HTTP -Anforderungen vollständig simulieren, und der Unterschied zwischen eingehenden und ausgehenden Parametern und tatsächlichen Bedingungen ist nahezu Null. Lassen Sie uns jedoch nur ein paar Informationen machen!
Vierteiliger integriert:
Schritt 1: Importieren Sie zwei Abhängigkeiten. Wenn Sie kein Maven -Projekt sind, können Sie nach dem JAR -Paket suchen. Denken Sie daran, dass nur zwei benötigt werden. Ich sah, dass ich sieben oder acht von ihnen in andere Tutorials vorgestellt habe, was ein Verschwendung ist.
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version></dependency>
Schritt 2: Fügen Sie eine Klasse hinzu (kopieren Sie die folgende Kopie. Bitte beachten Sie, dass Sie den Paketnamen und die Adresse ändern können).
/** * Swagger-Konfiguration * * @Author WQ * @Since 2017-05-16 */ @enableWebmvc @enablewagger2 @configurationPublic Class SwaggerConfig {@Bean Public Docket CReateReStapi () {Return New Docket (DokumentationType.Swagger_2) .APIINFO (APIINFO () .APIINFO (APIINFO () .APIINFO () .APIINFO () .APIINFO () .APIINFO (). .APIS (RequestHandlerSelectors.Basepackage ("com.z*.b*.c*.Controller")) // Beachten Sie, dass Sie den Paketnamen hier ändern. } private apiInfo apiinfo () {Neue apiinfobuilder () .Title ("Schnittstellenliste v1.1.0") // Any, bitte regulieren Sie es ein wenig. eigene IP: Port .Contact ("laowu") // Es spielt keine Rolle (hier ist der Alias des Autors) .version ("1.1.0") .build (); }} Schritt 3: Fügen Sie der MVC -Konfigurationsdatei die folgende Konfiguration hinzu. Vielleicht heißt Ihre Datei dispatcher.xml genannt! (Einfach kopieren, keine Änderung ist erforderlich)
<mvc: ressourcen maping = "swagger-ui.html" location = "classpath:/meta-inf/ressourcen/"/>> <mvc: ressourcen maping = "/webjars/**" location = "classpath:/meta-inf/ressourcen/webjars/"/>
Schritt 4: Annotationen zu Methoden und Parametern hinzufügen
Verfahren:
@Apioperation (value = "Tutorial", httpMethod = "post", Notes = "Tutorial")
Setzen Sie es in die Registrierung ein:
@APIPARAM (erforderlich = true, name = "test", value = "Tutorial Parameter")
Ich mache mir Sorgen, dass einige Freunde nicht ganz verstehen, also lass uns ein Bild machen!
Schritt 5: Starten Sie den Dienst und geben Sie den Browser ein:
http: // ip: port/swagger-ui.html
Der folgende Bildschirm wird angezeigt, dass die Aufgabe abgeschlossen ist:
Hinweis: Wenn Sie einen Interceptor in Ihrem Projekt verwenden, veröffentlichen Sie bitte die Swagger -Ressource (Sie können die folgende Konfiguration weiterhin direkt kopieren. Zweifel nicht V2).
<MVC: Ausschluss des Mapping Path = "/Swagger*/**"> </mvc: Ausschluss-Mapping> <mvc: exklusions-mapping path = "/v2/**"> </mvc: exklude-mapping> <mvc: exklusiv-mapping path = "/webjars/**"> </mvc: exklude-maping>
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.