OpenAPI extensions for API Gateway
The API Gateway extensions support the AWS-specific authorization and API Gateway-specific API integrations for REST APIs and HTTP APIs. In this section, we describe the API Gateway extensions to the OpenAPI specification.
Tip
To understand how the API Gateway extensions are used in an application, you can use the API Gateway console to create a REST API or HTTP API and export it to an OpenAPI definition file. For more information on how to export an API, see Export a REST API from API Gateway and Export HTTP APIs from API Gateway.
Topics
- x-amazon-apigateway-any-method object
- x-amazon-apigateway-cors object
- x-amazon-apigateway-api-key-source property
- x-amazon-apigateway-auth object
- x-amazon-apigateway-authorizer object
- x-amazon-apigateway-authtype property
- x-amazon-apigateway-binary-media-types property
- x-amazon-apigateway-documentation object
- x-amazon-apigateway-endpoint-configuration object
- x-amazon-apigateway-gateway-responses object
- x-amazon-apigateway-gateway-responses.gatewayResponse object
- x-amazon-apigateway-gateway-responses.responseParameters object
- x-amazon-apigateway-gateway-responses.responseTemplates object
- x-amazon-apigateway-importexport-version
- x-amazon-apigateway-integration object
- x-amazon-apigateway-integrations object
- x-amazon-apigateway-integration.requestTemplates object
- x-amazon-apigateway-integration.requestParameters object
- x-amazon-apigateway-integration.responses object
- x-amazon-apigateway-integration.response object
- x-amazon-apigateway-integration.responseTemplates object
- x-amazon-apigateway-integration.responseParameters object
- x-amazon-apigateway-integration.tlsConfig object
- x-amazon-apigateway-minimum-compression-size
- x-amazon-apigateway-policy
- x-amazon-apigateway-request-validator property
- x-amazon-apigateway-request-validators object
- x-amazon-apigateway-request-validators.requestValidator object
- x-amazon-apigateway-tag-value property