In diesem Artikel wird ein Beispiel für die Verwendung von Swagger2 im Spring Boot -Projekt vorgestellt. Es wird mit Ihnen geteilt. Die Details sind wie folgt:
Fügen Sie Swagger2 -Abhängigkeiten hinzu
Fügen Sie Swagger2 -Abhängigkeiten in pom.xml hinzu
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version></dependency><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version></dependency>
Erstellen Sie eine Swagger2 -Konfigurationsklasse
Erstellen Sie die Konfigurationsklasse von Swagger2 in der gleichzeitigen Ebene von application.java.
import org.springframework.context.annotation.bean; import org.springframework.context.annotation springfox.documentation.service.apiInfo; importfox.documentation.spi.documentationType; importfox.documentation.spring.web.plugins.docket; CReaterestapi () {Neues Docket zurückgeben (documentationType.swagger_2) .APIInfo (apiInfo ()) .Select () .APIS (RequestHandlerSelectors.Basepackage ("Ihr eigener externer Schnittstellenpaketname") .paths (pathselectors.any () .Build (); } private apiInfo apiinfo () {return New apiinfobuilder () .title ("Neo4j Restful apis") .Description ("Der Neo4j -Restful -APIS Beschreibung/") .termsofServiceUrl ("") .Contact ("li qinghai") .version ("5.00"). }}Dokumentinhalte hinzufügen
Nach Abschluss der oben genannten Konfiguration kann der Dokumentinhalt tatsächlich erstellt werden, aber solche Dokumente richten sich hauptsächlich auf die Anfrage selbst, und die Beschreibung stammt hauptsächlich aus der Benennung von Funktionen und anderen Funktionen, was nicht benutzerfreundlich ist. Normalerweise müssen wir einige Anweisungen hinzufügen, um den Dokumentinhalt zu bereichern.
import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import io.swagger.annotations.ApiParam;/** * System User Controller * * @author Li Qinghai* */@Api(value = "System User Interface", tags = "System Management")@RestController@RequestMapping("/v3/edu/users")public class UserController {@autowired private userservice userservice; /** * Benutzer hinzufügen, Register * * @param LoginName * Melden Sie sich bei Account an * @param userername * Benutzername * @param Passwort * Anmeldetwort * @param rollen * Benutzerrolle * @return * @Throws ressourcenexistsexception */@apioperation (value = "add user") @postmaping ("/") public JSONRESULTSULT (" @"). "Login account", required = true) @RequestParam(required = true) @RequestBody String loginName, @ApiParam(name = "userName", value = "User name", required = true) @RequestParam(required = true) @RequestBody String userName, @ApiParam(name = "password", value = "Log in password", required = true) @RequestParam(required = true) @RequestBody String -Passwort, @APIPARAM (name = "rollenID", value = "Benutzerrolle", fordert = true) @RequestParam (fordert = true) @RequestBody String rollen) löst eine ResourceExistSexception aus (boolean exists = this.userService.Exists (LoginName); if (existiert) {neue ResourceExistSexception (LoginName) werfen; } User user = userService.create (LoginName, Kennwort, Benutzername, RollenID); Neue JsonResult (Benutzer) zurückgeben; }}API anzeigen
Start Spring Boot-Programm und Besuch: http: // localhost: 8080/swagger-ui.html
API -Dokumentzugriff und Debuggen
Neben der Anzeige der Schnittstellenfunktion bietet Swagger auch Debugging- und Testfunktionen. Wir können auf das Modellschema (gelber Bereich: Es zeigt die Datenstruktur an) rechts im obigen Bild an. Zu diesem Zeitpunkt gibt es eine Vorlage für das Benutzerobjekt im Wert. Wir müssen es nur geringfügig ändern, klicken Sie unten aus ausprobieren! Button, Sie können einen Anforderungsanruf ausfüllen! Mehrere GET -Anforderungen können verwendet werden, um zu überprüfen, ob die vorherige Postanforderung korrekt ist.
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.