在Spring Boot中使用swagger-bootstrap-ui的方法

swagger-bootstrap-ui 是基於swagger接口api實現的一套UI,因swagger原生ui是上下結構的，在瀏覽接口時不是很清晰,所以， swagger-bootstrap-ui 是基於左右菜單風格的方式,適用與我們在開發後台系統左右結構這種風格類似,方便與接口瀏覽

GitHub: https://github.com/xiaoymin/Swagger-Bootstrap-UI

界面預覽：

引入swagger

在pom.xml文件中引入swagger以及ui的jar包依賴

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version></dependency><!--引入ui包--><dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.7</version></dependency>

配置configuration

配置swagger的啟用配置文件，關鍵註解@EnableSwagger2

一下配置是支持接口分組的配置，如果沒有分組配置,只需要創建一個Docket 即可

@Configuration@EnableSwagger2public class SwaggerConfiguration {​ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("資源管理") .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("實時監測") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.monitor.ctl")) .paths(PathSelectors.any()) .build(); } @Bean public Docket createActivitiRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("工作流引擎") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.activiti.ctl")) .paths(PathSelectors.any()) .build(); }​ @Bean public Docket createBaseRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("kernel模塊") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.kernel.ctl")) .paths(PathSelectors.any()) .build(); }​ @Bean public Docket createComplaintRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .groupName("投訴管理") .select() .apis(RequestHandlerSelectors.basePackage("com.lishiots.dc.complaint.ctl")) .paths(PathSelectors.any()) .build(); }​ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("swagger RESTful APIs") .description("swagger RESTful APIs") .termsOfServiceUrl("http://www.test.com/") .contact("[email protected]") .version("1.0") .build(); }}

Controller層使用swagger註解

ctl代碼層：​

 @Api(tags = "banner管理")@RestController@RequestMapping("/api/bannerInfo")public class BannerCtl { @Autowired private BannerInfoService service; @PostMapping("/query") @ApiOperation(value = "查詢banner",notes = "查詢banner") public Pagination<BannerInfo> bannerInfoQuery(){ Pagination<BannerInfo> pagination = service.bannerInfoQuery(); return pagination; }}

接口訪問

在瀏覽器輸入： http://${host}:${port}/doc.html

總結

以上所述是小編給大家介紹的在Spring Boot中使用swagger-bootstrap-ui的方法，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對武林網網站的支持！