Objeto x-amazon-apigateway-any-method - Amazon API Gateway
Exemplos de x-amazon-apigateway-any-method

Objeto x-amazon-apigateway-any-method

Especifica o Objeto de operação do OpenAPI para o método ANY genérico do API Gateway em um Objeto de item de caminho do OpenAPI. Esse objeto pode existir junto com outros objetos de operação e obterá qualquer método HTTP que não tenha sido explicitamente declarado.

A tabela a seguir lista as propriedades estendidas pelo API Gateway. Para as outras propriedades de Operação do OpenAPI, consulte a especificação OpenAPI.

Nome da propriedade Tipo Descrição
isDefaultRoute Boolean Especifica se uma rota é a rota do $default. Compatível apenas com APIs HTTP. Para saber mais, consulte Criar rotas para APIs HTTP no API Gateway.
x-amazon-apigateway-integration Objeto x-amazon-apigateway-integration Especifica a integração do método com o backend. Esta é uma propriedade estendida do objeto de Operação do OpenAPI. A integração pode ser de tipo AWS, AWS_PROXY, HTTP, HTTP_PROXY ou MOCK.

Exemplos de x-amazon-apigateway-any-method

O exemplo a seguir integra o método ANY em um recurso de proxy, {proxy+}, com uma função do Lambda, TestSimpleProxy.

    "/{proxy+}": {
      "x-amazon-apigateway-any-method": {
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "proxy",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {},
        "x-amazon-apigateway-integration": {
          "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:TestSimpleProxy/invocations",
          "httpMethod": "POST",
          "type": "aws_proxy"
        }

O exemplo a seguir cria uma rota $default para uma API HTTP que se integra a uma função do Lambda, HelloWorld.

"/$default": {
    "x-amazon-apigateway-any-method": {
      "isDefaultRoute": true,
      "x-amazon-apigateway-integration": {
        "type": "AWS_PROXY",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:HelloWorld/invocations",
        "timeoutInMillis": 1000,
        "connectionType": "INTERNET",
        "payloadFormatVersion": 1.0
      }
   }
}