Knife4j：Java 项目 API 文档的优雅增强工具

Knife4j 是一个为 Java 项目生成和管理 API 文档的工具。它实际上是 Swagger UI 的一个增强工具集，旨在让 Swagger 生成的 API 文档更优雅、更强大。

Knife4j 主要功能

• 美观的 UI：相比于原生 Swagger UI，Knife4j 提供了更加人性化和美观的界面设计。
• 丰富的文档交互功能：支持在线调试、请求参数动态输入、接口排序等。
• 个性化配置：可自定义 API 文档的界面风格，实现文档界面的个性化展示。

为什么要用它？

小伙伴们可能会疑惑，既然前后端自己可以包办，为什么还要搞 API 文档？其实，我们主要想用的是它的在线调试功能。在前面小节中，我们通过 Postman 来调试接口，每当测试一个新的接口时，就不得不手动填写请求路径，组装 JSON 入参格式，其实还是比较繁琐的。

有了 Knife4j，它支持在线调试，这块的时间就可以省下来了。本小节中，我们就来看看，如何通过 Knife4j 提升接口调试效率。

生产环境如何屏蔽 Knife4j？

很多时候，我们不想项目在生产环境中暴露出所有接口信息，只想在测试环境中联调使用，那么要如何屏蔽该功能呢？

Spring Boot Profile 特性

Profile 是 Spring Boot 中的一项特性，允许你在不同环境中使用不同的配置。这种机制使得我们可以轻松地在不同环境中（如开发、测试和生产环境）中使用不同的配置参数。

@Profile 注解

你可以在配置类上添加 @Profile 注解，来控制 Knife4j 是否生效。只有当指定的 Profile 处于激活状态时，该配置类才会被创建和被使用。代码如下：

@Configuration
@EnableSwagger2WebMvc
@Profile("dev") // 只在 dev 环境中开启
public class Knife4jConfig {
    // 省略...
}