knife4j是swagger的升级版
1、使用方式
1)、导入Maven依赖
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j-spring..version}</version>
2)、在config包下创建WebMvcConfiguration类并继承WebMvcConfigurationSupport类,加入knife4j相关配置
/**
* 通过knife4j生产接口文档
* @return
*/
@Bean
public Docket docket(){
ApiInfo apiInfo = new ApiInfoBuilder()
.title("自定义")
.version("2.0")
.description("自定义")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("自定义")
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("Controller包位置"))
.paths(PathSelectors.any())
.build();
return docket;
}
3)、设置静态资源映射,否则接口文档页面无法访问
/**
* 通过knife4j生产接口文档
* @return
*/
@Bean
public Docket docket(){
ApiInfo apiInfo = new ApiInfoBuilder()
.title("自定义")
.version("2.0")
.description("自定义")
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.groupName("自定义")
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("前端控制器位置"))
.paths(PathSelectors.any())
.build();
return docket;
}
运行项目访问路径:localhost:8080/doc.html
3、常用注解
@Api:用在类上,例如Controller,表示对类的说明
@ApiModel:用在类上,例如entity、DTO、VO
@ApiModelProperty:用在属性上,描述属性信息
@ApiOperation:用在方法上,例如Controller的方法,说明方法的用途、作用