问题描述
knife4j是目前比较主流的自动API文档生成工具,但是如何在生产环境屏蔽接口文档呢?
解决方案
介绍一个比较简单的方法:
1.将依赖更新至3.0.3或以上,旧的版本屏蔽不了/v3/api-docs
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
2.在生产环境的配置文件中添加如下配置:
knife4j:
# 开启knife4j增强
enable: true
# 开启生产环境屏蔽,一定要先开启knife4j增强才会生效
production: true
添加了这些配置后,会屏蔽掉所有的接口文档。
测试
ok,搞定