swagger api接口展示测试的可视化工具,非常有利于开发 测试接口,良好的接口展示界面,一目了然可以看到项目里所有的接口,并可以快速测试。也有利于前端查看接口入参出参。
- springboot 集成很简单,引入jar.
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
启动类添加如下内容:
// 添加swagger2
@EnableSwagger2
public class DemoApplication extends SpringBootServletInitializer {
// ....
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/")
.select()
// 选择那些路径和api会生成document
// 对所有api进行监控
.apis(RequestHandlerSelectors.any())
//不显示错误的接口地址
.paths(Predicates.not(PathSelectors.regex("/error.*")))
// 对根下所有路径进行监控
// .paths(PathSelectors.regex("/.*"))
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("这是我的接口文档")
.description("这是SWAGGER_2生成的接口文档")
.termsOfServiceUrl("NO terms of service")
// .license("The Apache License, Version 2.0")
// .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
.version("v1.0")
.build();
}
}
- 效果: