Spring Boot 禁用 Swagger 的三种方式

在Spring Boot项目中,你可以通过以下几种方式来禁用Swagger。

  1. 通过配置文件禁用

application.propertiesapplication.yml文件中,你可以添加以下配置来禁用Swagger:




# application.properties
springfox.documentation.enabled=false

或者




# application.yml
springfox:
  documentation:
    enabled: false
  1. 通过Java配置禁用

如果你使用Java配置类自定义Swagger,你可以在该类中禁用Swagger:




import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).enable(false);
    }
}
  1. 通过条件注解禁用

如果你不想通过配置文件来禁用Swagger,你可以使用条件注解来在特定条件下禁用Swagger配置类:




import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@Configuration
@Conditional(SwaggerDisabledCondition.class)
@EnableSwagger2
public class SwaggerConfig {
    // Swagger beans, APIs, and configurations
}
 
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
 
public class SwaggerDisabledCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 通过某些条件来判断是否禁用Swagger,例如通过环境变量或系统属性
        return !Boolean.parseBoolean(System.getProperty("swagger.enabled"));
    }
}

在上面的例子中,SwaggerDisabledCondition 类根据系统属性 swagger.enabled 的值来决定是否启用Swagger。如果你不想通过条件注解来禁用,那么你可以选择前两种方式。

最后修改于:2024年09月03日 18:36

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日