在使用swagger 之后之后虽然提供了方便,但是却经常收到相关网络安全预警通报。所以今天记录以下相关简单快捷的关闭方法。
如果用的是OpenAPI
例子
@Configuration
@Profile({"dev", "test"})
public class OpenAipConfig {
@Bean
public OpenAPI openAPI() {
OpenAPI openAPI = new OpenAPI();
Info info = new Info();
info.setDescription("测试");
openAPI.setInfo(info);
return openAPI;
}
}
则可以在application.yml 添加以下配置实现禁用
springdoc:
swagger-ui:
enabled: false ## 只配置这个 只是访问doc.html 访问异常 但/v3/api-docs/ 可以正常访问
api-docs:
enabled: false ## 导致 /v3/api-docs/ 访问异常
如果用的是 Docket
例子
@Configuration
public class SwaggerConfig {
@Bean
@Profile({"dev", "test"})
public Docket aTest() {
AlternateTypeRule newRule = AlternateTypeRules.newRule(Date.class, Long.class);
ApiInfo apiInfo = new ApiInfo("测试", "测试接口文档",
"1.0", "", null, "", "",
new ArrayList<>(0));
return new Docket(DocumentationType.OAS_30)
.ignoredParameterTypes(User.class, CurrLogin.class, DevelopmentBaseVo.class)
.apiInfo(apiInfo)
.enable(true)
.alternateTypeRules(newRule);
}
}
则可以在application.yml 添加以下配置实现禁用
springfox:
documentation:
enabled: false