SpringBoot整合knife4j

引言

在快速迭代的软件开发中，高效、直观的API文档至关重要。SpringBoot整合Knife4j，以自动化生成、美观展示及便捷调试为特点，为开发者提供了强大的API管理工具，极大地提升了团队协作效率与文档管理水平，是现代软件开发中不可或缺的一环。

案例

1.打开springboot项目，查看springboot的版本，去官网选择对应的依赖

springboot的版本为2.6.13

knife4j官网地址：快速开始 | Knife4j 

找到对应的依赖

在pom文件中导入依赖

<!--        knife4j-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-spring-boot-starter</artifactId>
            <version>4.4.0</version>
        </dependency>

2.使用OpenAPI3的规范注解，注释各个Spring的REST接口

注释控制器

注释接口

注意@Operation要在 @xxMapping的上面

 

3.访问Knife4j的文档地址：http://localhost:8080/doc.html查看文档

这里可以看到你的实体类

 控制器的接口在这儿