Swagger-Bootstrap-UI ist eine UI, die basierend auf der Swagger-Schnittstelle-API implementiert ist. Da die native UI der Swagger eine obere und untere Struktur hat, ist sie beim Durchsuchen der Schnittstelle nicht sehr klar. Daher basiert Swagger-Bootstrap-UI auf dem linken und rechten Menüstil, der dem Stil der linken und rechten Strukturen im Entwicklungs-Backend-System ähnelt, das zum Surfen mit der Schnittstelle bequem ist.
Github: https://github.com/xiaoymin/swagger-bootstrap-ui
Schnittstellenvorschau:
Prahlerei einführen
Führen Sie die JAR -Paketabhängigkeiten von Swagger und UI in die Datei pom.xml ein
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version></dependency><!--Introducing ui package--><dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version> 1.7 </Version> </abhängig>
Konfigurieren Sie die Konfiguration
Konfigurieren Sie die Konfigurationsdatei von Swagger, Key Annotation @enableWagger2
Die folgende Konfiguration ist eine Konfiguration, die die Schnittstellengruppierung unterstützt. Wenn es keine Gruppierungskonfiguration gibt, müssen Sie nur ein Docket erstellen.
@Configuration @enableWagger2Public Class SwaggerConfiguration {@Bean public docket createrestapi () {neuer Docket zurückgeben (documentationType.swagger_2) .apiinfo (apiInfo ()) .Groupname ("Ressourcenverwaltung") .Select () .Select (). .APIS (RequestHandlerSelectors.Basepackage ("com.lishiots.dc.baseinfo.ctl")) .Paths (PathSelectors.any ()) .build (); } @Bean public Docket createMonitorRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("Real-time Monitoring") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.monitor.ctl")) .paths(PathSelectors.any()) .bauen(); } @Bean public Docket createActivitiRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("Workflow Engine") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.activiti.ctl")) .Paths (PathSelectors.anan ()) .build (); } @Bean public docket createBaSerestAPI () {return New Docket (documentationType.swagger_2) .APIINFO (apiInfo () .Groupname ("Kernel -Modul") .Select () .APIS (RequestHandlerSelectors.Basepackage ("com.lishiots.dc.Dc.Kern.Dc.Kern.Cern. .bauen(); } @Bean public docket CreateComplainTrestAPI () {neuer Docket (documentationType.swagger_2) .APIInfo (apiInfo () .Groupname ("Beschwerdemanagement") .Select () .APIS (RequestHandlerSelectors.Basepackage ("com.lishiots.dc.comPlaint.Ct.Claint.Claint.Ctc.Cl. .bauen(); } Private apiInfo apiinfo () {Neue apiinfobuilder () .Title ("Swagger restful apis") .Description ("Swagger restful apis") .termsofServiceUrl ("http://www.test.com/") .contact ("xiaymin@fox@[email protected]"). .bauen(); }}Controller Layer verwendet Sprist -Annotation
CTL -Codeschicht:
@API (Tags = "Banner Management")@rastController@RequestMapping ("/api/bannerInfo") Bannerctl {@autowired Private BannerInfoService Service; @Postmapping ("/query") @apioperation (value = "Query Banner", Notes = "Query Banner") Public Pagination <Bannerinfo> bannerinfoquery () {Pagination <Bannerinfo> pagination = Service.BannerinFoquery (); Return Pagination; }}Schnittstellenzugriff
Geben Sie in den Browser ein: http: // $ {host}: $ {port} /doc.html
Zusammenfassen
Die oben genannte Methode ist die Verwendung von Swagger-Bootstrap-UI in Spring Boot, die Ihnen vorgestellt wurde. Ich hoffe, es wird Ihnen hilfreich sein. Wenn Sie Fragen haben, hinterlassen Sie mir bitte eine Nachricht und der Editor wird Ihnen rechtzeitig antworten. Vielen Dank für Ihre Unterstützung auf der Wulin.com -Website!