package com.kri.common.autoconfigure.swagger; import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; import com.kri.common.runtime.swagger.CodeEnumOpenApiCustomizer; import com.kri.common.runtime.swagger.CodeEnumModelConverter; import com.kri.common.runtime.swagger.CodeEnumSwaggerSupport; import com.kri.common.runtime.swagger.SwaggerIpFilter; import io.swagger.v3.core.converter.AnnotatedType; import io.swagger.v3.core.converter.ModelConverter; 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.media.Schema; import io.swagger.v3.oas.models.parameters.Parameter; import io.swagger.v3.oas.models.security.SecurityRequirement; import io.swagger.v3.oas.models.security.SecurityScheme; import lombok.RequiredArgsConstructor; import org.springdoc.core.customizers.GlobalOpenApiCustomizer; import org.springdoc.core.customizers.ParameterCustomizer; import org.springdoc.core.customizers.PropertyCustomizer; 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; import org.springframework.core.MethodParameter; @AutoConfiguration(beforeName = "org.springdoc.core.configuration.SpringDocConfiguration") @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 bearerRequirement = new SecurityRequirement() .addList("BearerAuth"); SecurityRequirement apiKeyRequirement = new SecurityRequirement() .addList("ApiKeyAuth"); return new OpenAPI() .components(components) .addSecurityItem(bearerRequirement) .addSecurityItem(apiKeyRequirement) .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 = "codeEnumModelConverter") public ModelConverter codeEnumModelConverter() { return new CodeEnumModelConverter(); } @Bean @ConditionalOnMissingBean(name = "codeEnumPropertyCustomizer") public PropertyCustomizer codeEnumPropertyCustomizer() { return (Schema property, AnnotatedType type) -> { CodeEnumSwaggerSupport.resolveCodeEnumClass(type) .ifPresent(enumClass -> CodeEnumSwaggerSupport.applyEnumMetadata(property, enumClass)); return property; }; } @Bean @ConditionalOnMissingBean(name = "codeEnumParameterCustomizer") public ParameterCustomizer codeEnumParameterCustomizer() { return (Parameter parameterModel, MethodParameter methodParameter) -> { CodeEnumSwaggerSupport.resolveCodeEnumClass(methodParameter.getParameterType()) .ifPresent(enumClass -> { CodeEnumSwaggerSupport.applyEnumMetadata(parameterModel.getSchema(), enumClass); parameterModel.description( CodeEnumSwaggerSupport.mergeEnumDescription(parameterModel.getDescription(), enumClass)); }); return parameterModel; }; } @Bean @ConditionalOnMissingBean(name = "codeEnumOpenApiCustomizer") public GlobalOpenApiCustomizer codeEnumOpenApiCustomizer() { return new CodeEnumOpenApiCustomizer(properties.getBasePackage()); } @Bean @ConditionalOnMissingBean(name = "swaggerIpFilter") public FilterRegistrationBean swaggerIpFilter() { FilterRegistrationBean 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; } }