Spring Boot 禁用 Swagger 的三种方式
在Spring Boot项目中,你可以通过以下几种方式来禁用Swagger。
- 通过配置文件禁用
在application.properties
或application.yml
文件中,你可以添加以下配置来禁用Swagger:
# application.properties
springfox.documentation.enabled=false
或者
# application.yml
springfox:
documentation:
enabled: false
- 通过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);
}
}
- 通过条件注解禁用
如果你不想通过配置文件来禁用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。如果你不想通过条件注解来禁用,那么你可以选择前两种方式。
评论已关闭