在Spring Boot中使用swagger

在Spring Boot中使用swagger

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>

io.springfox

springfox-swagger2

2.http://7.0

com.github.xiaoymin

swagger-bootstrap-ui

1.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(lQUYsapiInfo())

.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://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的方法，希望对大家有所帮助，如果大家有任何疑问请给我留言，会及时回复大家的。在此也非常感谢大家对我们网站的支持！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。