完善 YudaoSwaggerAutoConfiguration 注释

pull/2/head
YunaiV 2022-07-03 17:25:11 +08:00
parent 33d094697d
commit f0095a2c31
2 changed files with 13 additions and 14 deletions

View File

@ -29,6 +29,10 @@ package cn.iocoder.yudao.framework.common.exception.enums;
*/ */
public class ServiceErrorCodeRange { public class ServiceErrorCodeRange {
// 模块 system 错误码区间 [1-000-001-000 ~ 1-000-002-000] // 模块 infra 错误码区间 [1-001-000-000 ~ 1-002-000-000)
// 模块 system 错误码区间 [1-002-000-000 ~ 1-003-000-000)
// 模块 member 错误码区间 [1-004-000-000 ~ 1-005-000-000)
// 模块 pay 错误码区间 [1-007-000-000 ~ 1-008-000-000)
// 模块 bpm 错误码区间 [1-009-000-000 ~ 1-010-000-000)
} }

View File

@ -3,7 +3,6 @@ package cn.iocoder.yudao.framework.swagger.config;
import cn.iocoder.yudao.framework.swagger.core.SpringFoxHandlerProviderBeanPostProcessor; import cn.iocoder.yudao.framework.swagger.core.SpringFoxHandlerProviderBeanPostProcessor;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
@ -45,27 +44,22 @@ public class YudaoSwaggerAutoConfiguration {
} }
@Bean @Bean
@ConditionalOnMissingBean public Docket createRestApi(SwaggerProperties properties) {
public SwaggerProperties swaggerProperties() {
return new SwaggerProperties();
}
@Bean
public Docket createRestApi() {
SwaggerProperties properties = swaggerProperties();
// 创建 Docket 对象 // 创建 Docket 对象
return new Docket(DocumentationType.SWAGGER_2) return new Docket(DocumentationType.SWAGGER_2)
// 用来创建该 API 的基本信息,展示在文档的页面中(自定义展示的信息) // ① 用来创建该 API 的基本信息,展示在文档的页面中(自定义展示的信息)
.apiInfo(apiInfo(properties)) .apiInfo(apiInfo(properties))
// 设置扫描指定 package 包下的 // ② 设置扫描指定 package 包下的
.select() .select()
.apis(basePackage(properties.getBasePackage())) .apis(basePackage(properties.getBasePackage()))
// .apis(basePackage("cn.iocoder.yudao.module.system")) // 可用于 swagger 无法展示时使用 // .apis(basePackage("cn.iocoder.yudao.module.system")) // 可用于 swagger 无法展示时使用
.paths(PathSelectors.any()) .paths(PathSelectors.any())
.build() .build()
// ③ 安全上下文(认证)
.securitySchemes(securitySchemes()) .securitySchemes(securitySchemes())
.globalRequestParameters(globalRequestParameters()) .securityContexts(securityContexts())
.securityContexts(securityContexts()); // ④ 全局参数(多租户 header
.globalRequestParameters(globalRequestParameters());
} }
// ========== apiInfo ========== // ========== apiInfo ==========
@ -100,6 +94,7 @@ public class YudaoSwaggerAutoConfiguration {
private static List<SecurityContext> securityContexts() { private static List<SecurityContext> securityContexts() {
return Collections.singletonList(SecurityContext.builder() return Collections.singletonList(SecurityContext.builder()
.securityReferences(securityReferences()) .securityReferences(securityReferences())
// 通过 PathSelectors.regex("^(?!auth).*$"),排除包含 "auth" 的接口不需要使用securitySchemes
.forPaths(PathSelectors.regex("^(?!auth).*$")) .forPaths(PathSelectors.regex("^(?!auth).*$"))
.build()); .build());
} }