概述:knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
官网Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j
1.依赖
<!-- 集成swagger-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.1</version>
</dependency>
2.相关配置
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
import java.util.ArrayList;
import java.util.List;
/**
* knife4j配置信息
*/
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {
@Bean
public Docket adminApiConfig(){
List<Parameter> pars = new ArrayList<>();
/*
ParameterBuilder tokenPar = new ParameterBuilder();
tokenPar.name("token")
.description("用户token")
.defaultValue("")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.build();
pars.add(tokenPar.build());*/
//添加head参数end
Docket adminApi = new Docket(DocumentationType.SWAGGER_2)
.groupName("dpApi")
.apiInfo(adminApiInfo())
.select()
/*
* RequestHandlerSelectors配置如何扫描接口
* any()全部扫描
* none()不扫描
* basePackage()扫描指定包下的接口
* withClassAnnotation:扫描带有指定注解的类
* withMethodAnnotation:扫描带有指定注解的方法
*
* */
.apis(RequestHandlerSelectors.basePackage("com.llkj.dp"))
// .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
// 设置请求前缀,支持正则表达式
.paths(PathSelectors.regex("/dp/.*"))
.build()
.globalOperationParameters(pars);
return adminApi;
}
private ApiInfo adminApiInfo(){
return new ApiInfoBuilder()
.title("点评系统-API文档")
.description("本文档描述了点评系统微服接口定义")
.version("1.0")
.contact(new Contact("qy", "http://llkj.top", "3062738937@qq.com"))
.build();
}
}
3.Swagger注解
注解 | 说明 |
@Api(tags="xxx模块说明") | 作用在模块上 |
@ApiParam("xxx参数说明") | 作用在参数、方法和字段上,required为true表示必传参数 |
@ApiModel("xxxPOJO说明") | 作用在模型上 |
@ApiOperation("xxx接口说明") | 作用接口方法上 |
@ApiModelProperty(value=“xxx属性说明",hidden=true) | 作用在类方法和属性上,hidden为true可以隐藏该属性,require为true表示添加或修改数据时必填参数 |