260407_01_ENH: CodeEnum의 내용을 Swagger에 자동으로 표기하는 기능 추가

This commit is contained in:
2026-04-07 10:08:06 +09:00
parent 12b2b72121
commit 59f656b99b
5 changed files with 579 additions and 2 deletions

View File

@@ -1,13 +1,23 @@
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;
@@ -16,8 +26,9 @@ 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
@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)
@@ -72,6 +83,42 @@ public class KriSwaggerAutoConfiguration {
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> swaggerIpFilter() {