Package software.amazon.smithy.aws.apigateway.openapi

Interface ApiGatewayMapper

All Superinterfaces:

OpenApiMapper

All Known Implementing Classes:

CorsHttpIntegration

public interface ApiGatewayMapper
extends OpenApiMapper

An API Gateway mapper that only applies when the type of API being converted matches the types of APIs handled by the mapper.

Method Summary

Modifier and Type	Method	Description
List<ApiGatewayConfig.ApiType>	getApiTypes()	Gets the types of API Gateway APIs that this mapper applies to.
static OpenApiMapper	wrap(ApiGatewayMapper delegate)	Wraps and delegates to an ApiGatewayMapper IFF the configured ApiGatewayConfig.ApiType matches the types of APIs that the wrapped mapper applies to.

Methods inherited from interface software.amazon.smithy.openapi.fromsmithy.OpenApiMapper

after, before, getOrder, postProcessOperation, updateDefaultSettings, updateNode, updateOperation, updateParameter, updatePathItem, updateRequestBody, updateResponse, updateSecurity, updateSecurityScheme

Method Details

getApiTypes

List<ApiGatewayConfig.ApiType> getApiTypes()

Gets the types of API Gateway APIs that this mapper applies to.

Return an empty list or null to apply to all possible API types other than ApiGatewayConfig.ApiType.DISABLED. However, note that it's typically safer to specify the exact API types that the mapper supports.

Returns:

Returns the list of API Gateway API types to apply to.

wrap

static OpenApiMapper wrap(ApiGatewayMapper delegate)

Wraps and delegates to an ApiGatewayMapper IFF the configured ApiGatewayConfig.ApiType matches the types of APIs that the wrapped mapper applies to.

Parameters:

delegate - Mapper to delegate to when it applies to the configured API type.

Returns:

Returns the wrapped mapper.