Java中SpringBoot组件集成接入【Knife4j接口文档】
-
- 1.Knife4j介绍
- 2.maven依赖
- 3.配置类
- 4.常用注解使用
-
- 1.实体类及属性（@ApiModel和@ApiModelProperty）
- 2.控制类及方法（@Api、@ApiOperation、@ApiImplicitParam、 @ApiResponses）
- 3.@ApiOperationSupport注解未生效的解决方法
- 5.效果展示
- 6.参考文章
1.Knife4j介绍
Knife4j是一款基于Swagger的开源API文档管理工具，具有易用性和丰富的功能。它可以方便地生成和展示RESTful API接口文档，并提供了强大的交互式界面。
Knife4j具有以下主要特点：
- 集成Swagger：Knife4j是在Swagger UI基础上进行扩展和优化的，能够完美兼容Swagger的注解和配置，生成符合OpenAPI规范的API文档。
- 强大的交互式界面：Knife4j的界面友好、美观，提供了接口测试、调试和在线调用等功能，使得开发者可以更方便地与API进行交互。
- 自动生成接口文档：通过Knife4j的各种注解，开发人员可以方便地在代码中定义接口信息和参数说明，然后Knife4j会根据这些注解自动生成API文档，减少了手动维护文档的工作量。
- 接口权限管理：Knife4j支持对API接口进行权限管理，可以通过配置权限策略，限制只有授权用户才能够访问和调用指定的接口。
- 支持自定义扩展：Knife4j支持自定义主题样式、接口分类、接口分组等功能，可以根据实际需求进行个性化定制。
总的来说，Knife4j简化了API文档的编写和管理工作，提供了交互性强、易于使用的界面，方便开发团队进行接口开发和测试工作。它是一款非常实用的API文档管理工具。
参考：Knife4j官方文档
2.maven依赖
<!--knife4j依赖库-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
3.配置类
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors
