解决knife4j生产环境(线上)接口暴露

问题描述

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,搞定

 

 

 

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
关闭Knife4j可以通过以下步骤: 1. 在pom.xml文件中移除knife4j依赖。如果使用的是Spring Boot,可以在pom.xml文件中找到相关的依赖并将其注释或删除。 2. 在Swagger配置类中禁用Knife4j。可以通过在Swagger配置类中添加以下代码来禁用Knife4j: ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private Environment env; @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("your.base.package")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()) .enable("dev".equals(env.getActiveProfiles()[0])); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Your API title") .description("Your API description") .version("1.0.0") .build(); } } ``` 在上面的代码中,我们通过在Docket bean中调用enable()方法来禁用Knife4j。在这个例子中,我们只在开发环境中启用Swagger,而在其他环境中禁用它。 3. 在Web配置类中禁用Knife4j。如果使用的是Spring MVC,可以通过在Web配置类中添加以下代码来禁用Knife4j: ``` @Configuration public class WebMvcConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addRedirectViewController("/", "/swagger-ui.html"); } } ``` 在上面的代码中,我们通过重定向/请求到/swagger-ui.html来禁用Knife4j。这样,当我们访问应用程序的根路径时,将直接跳转到Swagger UI页面,而不是Knife4j页面。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值