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

这篇文章主要介绍了在Spring Boot中使用swagger-bootstrap-ui的方法,需要的朋友可以参考下

swagger-bootstrap-ui 是基于swagger接口api实现的一套UI,因swagger原生ui是上下结构的，在浏览接口时不是很清晰,所以， swagger-bootstrap-ui 是基于左右菜单风格的方式,适用与我们在开发后台系统左右结构这种风格类似,方便与接口浏览

GitHub:

界面预览：

引入swagger

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

  io.springfoxspringfox-swagger22.7.0 com.github.xiaoyminswagger-bootstrap-ui1.7

配置configuration

配置swagger的启用配置文件，关键注解 @EnableSwagger2

一下配置是支持接口分组的配置，如果没有分组配置,只需要创建一个 Docket 即可

 @Configuration @EnableSwagger2 public 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("xiaoymin@foxmail.com") .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 bannerInfoQuery(){ Pagination pagination = service.bannerInfoQuery(); return pagination; } }

接口访问

在浏览器输入： http://${host}:${port}/doc.html

总结

以上就是在Spring Boot中使用swagger-bootstrap-ui的方法的详细内容，更多请关注0133技术站其它相关文章！