knife4j

最新推荐文章于 2025-05-28 11:25:53 发布

原创最新推荐文章于 2025-05-28 11:25:53 发布 · 279 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

本文介绍如何使用Springfox Swagger2与Knife4j增强API文档。通过具体配置示例展示了如何设置Docket组件来定义API文档的元数据、分组、扫描路径等。

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
* 注解@EnableSwagger2：
* 是Springfox-swagger框架提供的使用Swagger注解，该注解必须加
* 注解@EnableKnife4j：
* knife4j提供的增强注解，Ui提供了例如动态参数、参数过滤、接口排序等增强功能
* 如果你想使用这些增强功能就加该注解，否则可以不用加
*/
@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger2Configuration {

@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//分组名称
.groupName("1.0")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("扫描路径"))
.paths(PathSelectors.any())
.build();
return docket;
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("文档名")
.description("文档名")
.version("版本")
.build();
}
}