OpenApiConfiguration.java

package com.checkout.payment.gateway.configuration;

import com.checkout.payment.gateway.security.ApiKeyAuthenticationFilter;
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 org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenApiConfiguration {

    public static final String API_KEY_SCHEME = "apiKeyAuth";

    @Bean
    public OpenAPI paymentGatewayOpenApi() {
        return new OpenAPI()
                .info(new Info()
                        .title("Payment Gateway API")
                        .description("Versioned merchant API. Use header "
                                + ApiKeyAuthenticationFilter.API_KEY_HEADER
                                + " for authentication. Optional Idempotency-Key on POST /payments.")
                        .version("v1"))
                .addSecurityItem(new SecurityRequirement().addList(API_KEY_SCHEME))
                .components(new Components().addSecuritySchemes(API_KEY_SCHEME,
                        new SecurityScheme()
                                .name(ApiKeyAuthenticationFilter.API_KEY_HEADER)
                                .type(SecurityScheme.Type.APIKEY)
                                .in(SecurityScheme.In.HEADER)));
    }
}