260626_01_ENH: admin용 swagger 안뜨던 문제 수정
This commit is contained in:
@@ -4,7 +4,7 @@ plugins {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// 버전 변경은 여기서
|
// 버전 변경은 여기서
|
||||||
def commonVer = "beta.1.1.29"
|
def commonVer = "beta.1.1.30"
|
||||||
|
|
||||||
group = 'com.kri.common'
|
group = 'com.kri.common'
|
||||||
version = commonVer
|
version = commonVer
|
||||||
|
|||||||
@@ -14,6 +14,8 @@ import io.swagger.v3.oas.models.media.Schema;
|
|||||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||||
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
||||||
import io.swagger.v3.oas.models.security.SecurityScheme;
|
import io.swagger.v3.oas.models.security.SecurityScheme;
|
||||||
|
import java.util.LinkedHashSet;
|
||||||
|
import java.util.Set;
|
||||||
import lombok.RequiredArgsConstructor;
|
import lombok.RequiredArgsConstructor;
|
||||||
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
|
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
|
||||||
import org.springdoc.core.customizers.ParameterCustomizer;
|
import org.springdoc.core.customizers.ParameterCustomizer;
|
||||||
@@ -35,6 +37,8 @@ import org.springframework.core.MethodParameter;
|
|||||||
@RequiredArgsConstructor
|
@RequiredArgsConstructor
|
||||||
public class KriSwaggerAutoConfiguration {
|
public class KriSwaggerAutoConfiguration {
|
||||||
|
|
||||||
|
private static final String API_KEY_ADMIN_PACKAGE = "com.kri.common.endpoint.auth.apikey";
|
||||||
|
|
||||||
private final KriSwaggerProperties properties;
|
private final KriSwaggerProperties properties;
|
||||||
private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽기용
|
private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽기용
|
||||||
|
|
||||||
@@ -77,9 +81,13 @@ public class KriSwaggerAutoConfiguration {
|
|||||||
.group("kri-api")
|
.group("kri-api")
|
||||||
.pathsToMatch("/api/**", "/internal/**");
|
.pathsToMatch("/api/**", "/internal/**");
|
||||||
|
|
||||||
String base = properties.getBasePackage();
|
Set<String> packagesToScan = new LinkedHashSet<>(properties.getBasePackage());
|
||||||
if (base != null && !base.isBlank()) {
|
if (apiKeyProperties.isAdminApiEnabled()) {
|
||||||
builder.packagesToScan(base, "com.kri.common.feature.auth.apikey");
|
packagesToScan.add(API_KEY_ADMIN_PACKAGE);
|
||||||
|
}
|
||||||
|
packagesToScan.removeIf(pack -> pack == null || pack.isBlank());
|
||||||
|
if (!packagesToScan.isEmpty()) {
|
||||||
|
builder.packagesToScan(packagesToScan.toArray(String[]::new));
|
||||||
}
|
}
|
||||||
|
|
||||||
return builder.build();
|
return builder.build();
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ public class KriSwaggerProperties {
|
|||||||
/**
|
/**
|
||||||
* 臾몄꽌?뷀븷 base package (null ?대㈃ ?꾩껜)
|
* 臾몄꽌?뷀븷 base package (null ?대㈃ ?꾩껜)
|
||||||
*/
|
*/
|
||||||
private String basePackage;
|
private List<String> basePackage = new ArrayList<>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Swagger ?묎렐 ?덉슜 IP 紐⑸줉 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1? 湲곕낯 ?덉슜)
|
* Swagger ?묎렐 ?덉슜 IP 紐⑸줉 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1? 湲곕낯 ?덉슜)
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import io.swagger.v3.oas.models.media.Schema;
|
|||||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||||
import io.swagger.v3.oas.models.responses.ApiResponse;
|
import io.swagger.v3.oas.models.responses.ApiResponse;
|
||||||
import java.lang.reflect.Field;
|
import java.lang.reflect.Field;
|
||||||
|
import java.util.List;
|
||||||
import java.util.LinkedHashMap;
|
import java.util.LinkedHashMap;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
|
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
|
||||||
@@ -19,11 +20,11 @@ import org.springframework.context.annotation.ClassPathScanningCandidateComponen
|
|||||||
|
|
||||||
public class CodeEnumOpenApiCustomizer implements GlobalOpenApiCustomizer {
|
public class CodeEnumOpenApiCustomizer implements GlobalOpenApiCustomizer {
|
||||||
|
|
||||||
private final String basePackage;
|
private final List<String> basePackages;
|
||||||
private Map<String, Class<?>> componentClasses;
|
private Map<String, Class<?>> componentClasses;
|
||||||
|
|
||||||
public CodeEnumOpenApiCustomizer(String basePackage) {
|
public CodeEnumOpenApiCustomizer(List<String> basePackages) {
|
||||||
this.basePackage = basePackage;
|
this.basePackages = basePackages;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
@@ -169,7 +170,7 @@ public class CodeEnumOpenApiCustomizer implements GlobalOpenApiCustomizer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private Map<String, Class<?>> collectComponentClasses(Map<String, Schema> schemas) {
|
private Map<String, Class<?>> collectComponentClasses(Map<String, Schema> schemas) {
|
||||||
if (schemas == null || schemas.isEmpty() || basePackage == null || basePackage.isBlank()) {
|
if (schemas == null || schemas.isEmpty() || basePackages == null || basePackages.isEmpty()) {
|
||||||
return Map.of();
|
return Map.of();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -182,16 +183,22 @@ public class CodeEnumOpenApiCustomizer implements GlobalOpenApiCustomizer {
|
|||||||
new ClassPathScanningCandidateComponentProvider(false);
|
new ClassPathScanningCandidateComponentProvider(false);
|
||||||
scanner.addIncludeFilter(new AllClassesTypeFilter());
|
scanner.addIncludeFilter(new AllClassesTypeFilter());
|
||||||
|
|
||||||
for (var beanDefinition : scanner.findCandidateComponents(basePackage)) {
|
for (String basePackage : basePackages) {
|
||||||
String className = beanDefinition.getBeanClassName();
|
if (basePackage == null || basePackage.isBlank()) {
|
||||||
if (className == null || className.isBlank()) {
|
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
for (var beanDefinition : scanner.findCandidateComponents(basePackage)) {
|
||||||
Class<?> clazz = Class.forName(className);
|
String className = beanDefinition.getBeanClassName();
|
||||||
classes.putIfAbsent(clazz.getSimpleName(), clazz);
|
if (className == null || className.isBlank()) {
|
||||||
} catch (ClassNotFoundException ignored) {
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
Class<?> clazz = Class.forName(className);
|
||||||
|
classes.putIfAbsent(clazz.getSimpleName(), clazz);
|
||||||
|
} catch (ClassNotFoundException ignored) {
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user