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

Objeto x-amazon-apigateway-any-method

Especifica el objeto Operation de OpenAPI para el método catch-all ANY de API Gateway en un objeto Path Item de OpenAPI. Este objeto puede existir junto con otros objetos Operation y capturar cualquier método HTTP que no se haya declarado de forma explícita.

En la siguiente tabla se muestran las propiedades ampliadas por API Gateway. Para el resto de las propiedades del objeto Operation de OpenAPI, consulte la especificación de OpenAPI.

Nombre de la propiedad Tipo Descripción
isDefaultRoute Boolean Especifica si una ruta es la ruta $default. Solo se admite para API HTTP. Para obtener más información, consulte Creación de rutas para las API de HTTP en API Gateway.
x-amazon-apigateway-integration Objeto x-amazon-apigateway-integration Especifica la integración del método con el backend. Se trata de una propiedad extendida del objeto Operation de OpenAPI. La integración puede ser del tipo AWS, AWS_PROXY, HTTP, HTTP_PROXY o MOCK.

Ejemplos de x-amazon-apigateway-any-method

En el siguiente ejemplo se integra el método ANY en un recurso de proxy, {proxy+}, con una función de 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"
        }

En el ejemplo siguiente se crea una ruta $default para una API HTTP que se integra con una función de 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
      }
   }
}