属于自己的文档,只用于简单参考。
添加依赖
<!--swagger2的依赖-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
添加Swagger配置
@Configuration
@EnableSwagger2 //开启swagger
public class SwaggerConfig{
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// basePackage() 配置要为哪个包下的接口生成api文档
// withMethodAnnotation(ApiOperation.class) 给添加了该注解的方法生成接口文档
// any() 给任意方法生成接口文档
.apis(RequestHandlerSelectors.basePackage("com.cai.primeton.controller"))
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
// .apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
Contact contact = new Contact("csp","","13298280305@163.com");
return new ApiInfoBuilder()
.title("接口文档")
.description("添加描述")
.contact(contact)
.version("1.0")
.build();
}
}
常用注解
@Api()
属性:tags = “”
@ApiOperation() 标注在要生成接口文档的方法上
属性:value = "" 方法说明
@ApiImplicitParam() 标注在要生成接口文档的方法上,用户介绍参数
属性: name = "" 参数名
value = "" 参数说明
测试
http://localhost:8085/swagger-ui.html