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

2019-11-26 10:21:00

字体：大中小

来源：转载

供稿：网友

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("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<BannerInfo> bannerInfoQuery(){  Pagination<BannerInfo> pagination = service.bannerInfoQuery();  return pagination; }}

接口访问

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

总结

以上所述是小编给大家介绍的在Spring Boot中使用swagger-bootstrap-ui的方法，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对武林网网站的支持！

上一篇：Java开发工具Eclipse使用技巧全局搜索和更替

下一篇：maven下载jar包改用阿里云maven库的方法