springboot+knife4j初体验

最新推荐文章于 2025-11-07 17:14:00 发布

原创

最新推荐文章于 2025-11-07 17:14:00 发布 · 1.4k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #knife4j

本文介绍了如何利用Knife4j作为接口文档工具，简化Spring Boot项目的接口文档编写与测试。从添加依赖、配置类、测试Controller到实体类的示例，详细展示了Knife4j的集成过程。此外，还提供了应用Knife4j后的接口调试与导出功能，助力提升开发效率。

Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案，帮助开发者快速聚合使用OpenAPI规范。
在这里插入图片描述
knife4j是一个很好的接口文档工具，前身是swagger-bootstrap-ui。早期，swagger-boostrap-ui是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字Knife4j，适用于单体和微服务项目。
使用knife4j是为了简化内部对接，便于测试和前端调试，以便简化程序猿编写接口文档，在本地环境和测试环境可以使用，考虑到安全问题不要暴露在生产环境。
实例
1、pom依赖
使用knife4j2.0.6及以上版本，springboot的版本必须在2.2.x以上

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <depende