SwaggerConfig.java

package akuma.whiplash.global.config.swagger;

import akuma.whiplash.domains.alarm.exception.AlarmErrorCode;
import akuma.whiplash.domains.auth.exception.AuthErrorCode;
import akuma.whiplash.domains.member.exception.MemberErrorCode;
import akuma.whiplash.global.annotation.swagger.CustomErrorCodes;
import akuma.whiplash.global.response.ApplicationResponse;
import akuma.whiplash.global.response.code.BaseErrorCode;
import akuma.whiplash.global.response.code.CommonErrorCode;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.examples.Example;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.media.Content;
import io.swagger.v3.oas.models.media.MediaType;
import io.swagger.v3.oas.models.responses.ApiResponse;
import io.swagger.v3.oas.models.responses.ApiResponses;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import io.swagger.v3.oas.models.servers.Server;
import java.util.List;
import org.springdoc.core.customizers.OperationCustomizer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.web.method.HandlerMethod;

@Configuration
public class SwaggerConfig {

    @Value("${swagger.server.url}")
    private String serverUrl;

    @Bean
    @Profile("local")
    public OpenAPI localOpenAPI() {
        return createOpenAPI(getLocalServer());
    }

    @Bean
    @Profile("dev")
    public OpenAPI devOpenAPI() {
        return createOpenAPI(getDevServer());
    }

    @Bean
    @Profile("prod")
    public OpenAPI prodOpenAPI() {return  createOpenAPI(getProdServer()); }

    private OpenAPI createOpenAPI(Server server) {
        return new OpenAPI()
                .components(new Components()
                        .addSecuritySchemes("bearerAuth", new SecurityScheme()
                                .type(SecurityScheme.Type.HTTP)
                                .scheme("bearer")
                                .bearerFormat("JWT")
                                .in(SecurityScheme.In.HEADER)
                                .name("Authorization"))
                )
                .servers(List.of(server))
                .info(new Info().title("눈 떠! API 명세서").version("1.0"))
                .addSecurityItem(new SecurityRequirement().addList("bearerAuth"));
    }

    private Server getLocalServer() {
        return new Server()
                .url(serverUrl)
                .description("Local Server");
    }

    private Server getDevServer() {
        return new Server()
                .url(serverUrl)
                .description("Dev Server");
    }

    private Server getProdServer() {
        return new Server()
            .url(serverUrl)
            .description("Prod Server");
    }

    @Bean
    public OperationCustomizer customize() {
        return (Operation operation, HandlerMethod handlerMethod) -> {
            CustomErrorCodes customErrorCodes = handlerMethod.getMethodAnnotation(CustomErrorCodes.class);

            if (customErrorCodes != null) {
                generateErrorCodeResponse(
                    operation,
                    customErrorCodes.commonErrorCodes(),
                    customErrorCodes.alarmErrorCodes(),
                    customErrorCodes.authErrorCodes(),
                    customErrorCodes.memberErrorCodes()
                );
            }

            return operation;
        };
    }

    private void generateErrorCodeResponse(
            Operation operation,
            CommonErrorCode[] commonErrorCodes,
            AlarmErrorCode[] alarmErrorCodes,
            AuthErrorCode[] authErrorCodes,
            MemberErrorCode[] memberErrorCodes
    ) {
        ApiResponses responses = operation.getResponses();

        if (commonErrorCodes != null) {
            for (CommonErrorCode errorCode : commonErrorCodes) {
                SwaggerExampleHolder SwaggerExampleHolder = getSwaggerExampleHolder(errorCode);
                addExamplesToResponses(responses, SwaggerExampleHolder);
            }

            for (AlarmErrorCode errorCode : alarmErrorCodes) {
                SwaggerExampleHolder SwaggerExampleHolder = getSwaggerExampleHolder(errorCode);
                addExamplesToResponses(responses, SwaggerExampleHolder);
            }

            for (AuthErrorCode errorCode : authErrorCodes) {
                SwaggerExampleHolder SwaggerExampleHolder = getSwaggerExampleHolder(errorCode);
                addExamplesToResponses(responses, SwaggerExampleHolder);
            }

            for (MemberErrorCode errorCode : memberErrorCodes) {
                SwaggerExampleHolder SwaggerExampleHolder = getSwaggerExampleHolder(errorCode);
                addExamplesToResponses(responses, SwaggerExampleHolder);
            }
        }
    }

    private SwaggerExampleHolder getSwaggerExampleHolder(BaseErrorCode errorCode) {
        return SwaggerExampleHolder.builder()
                .example(getSwaggerExample(errorCode))
                .name(errorCode.getCustomCode())
                .code(errorCode.getHttpStatus().value())
                .build();
    }

    /**
     * {@code @ApiErrorCodes} annotation 이 존재할 경우 {@code ApiResponses}에 {@code Example}을 추가
     */
    private void addExamplesToResponses(ApiResponses responses, SwaggerExampleHolder SwaggerExampleHolder) {
        String responseKey = String.valueOf(SwaggerExampleHolder.getCode());
        ApiResponse apiResponse = responses.computeIfAbsent(responseKey, k -> new ApiResponse());

        Content content = apiResponse.getContent();
        if (content == null) {
            content = new Content();
            apiResponse.setContent(content);
        }

        MediaType mediaType = content.computeIfAbsent("application/json", k -> new MediaType());
        mediaType.addExamples(SwaggerExampleHolder.getName() , SwaggerExampleHolder.getExample());
        responses.addApiResponse(responseKey, apiResponse);
    }

    /**
     * {@code BaseErrorCode}를 통해 {@code Example}을 생성
     */
    private Example getSwaggerExample(BaseErrorCode errorCode) {
        ApplicationResponse<Void> response = ApplicationResponse.onFailure(errorCode.getCustomCode(), errorCode.getMessage(), null);
        Example example = new Example();
        example.setValue(response);

        return example;
    }
}