260327_01_ENH: 프로젝트 구조 리펙토링 및 README.md 갱신

This commit is contained in:
2026-03-27 11:01:47 +09:00
parent e72d061e58
commit 905906b923
65 changed files with 531 additions and 1581 deletions

View File

@@ -0,0 +1,85 @@
package com.kri.common.autoconfigure.swagger;
import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties;
import com.kri.common.runtime.swagger.SwaggerIpFilter;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import lombok.RequiredArgsConstructor;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.boot.autoconfigure.AutoConfiguration;
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.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
@AutoConfiguration
@EnableConfigurationProperties(KriSwaggerProperties.class)
@ConditionalOnClass({OpenAPI.class, GroupedOpenApi.class})
@ConditionalOnProperty(prefix = "kri.swagger", name = "enabled", havingValue = "true", matchIfMissing = true)
@RequiredArgsConstructor
public class KriSwaggerAutoConfiguration {
private final KriSwaggerProperties properties;
private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽기용
@Bean
@ConditionalOnMissingBean
public OpenAPI kriOpenAPI() {
// JWT Bearer + API Key 스키마 정의
Components components = new Components()
.addSecuritySchemes("BearerAuth",
new SecurityScheme()
.type(SecurityScheme.Type.HTTP)
.scheme("bearer")
.bearerFormat("JWT"))
.addSecuritySchemes("ApiKeyAuth",
new SecurityScheme()
.type(SecurityScheme.Type.APIKEY)
.in(SecurityScheme.In.HEADER)
.name(apiKeyProperties.getHeaderName())); // 예: X-API-Key
// 두 보안 스키마를 기본 보안 요구사항으로 등록
SecurityRequirement securityRequirement = new SecurityRequirement()
.addList("BearerAuth")
.addList("ApiKeyAuth");
return new OpenAPI()
.components(components)
.addSecurityItem(securityRequirement)
.info(new Info()
.title(properties.getTitle())
.description(properties.getDescription())
.version(properties.getVersion()));
}
@Bean(name = "kriGroupedOpenApi")
@ConditionalOnMissingBean(name = "kriGroupedOpenApi")
public GroupedOpenApi kriGroupedOpenApi() {
GroupedOpenApi.Builder builder = GroupedOpenApi.builder()
.group("kri-api")
.pathsToMatch("/api/**", "/internal/**");
String base = properties.getBasePackage();
if (base != null && !base.isBlank()) {
builder.packagesToScan(base, "com.kri.common.feature.auth.apikey");
}
return builder.build();
}
@Bean
@ConditionalOnMissingBean(name = "swaggerIpFilter")
public FilterRegistrationBean<SwaggerIpFilter> swaggerIpFilter() {
FilterRegistrationBean<SwaggerIpFilter> registrationBean = new FilterRegistrationBean<>();
registrationBean.setFilter(new SwaggerIpFilter(properties.getAllowedIps()));
registrationBean.addUrlPatterns("/swagger-ui/*", "/v3/api-docs/*", "/swagger-ui.html");
registrationBean.setName("swaggerIpFilter");
registrationBean.setOrder(1);
return registrationBean;
}
}