View a markdown version of this page

Objet x-amazon-apigateway-any-method - Amazon API Gateway
Exemples x-amazon-apigateway-any-method

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Objet x-amazon-apigateway-any-method

Spécifie l’objet Opération OpenAPI de la méthode fourre-tout ANY d’API Gateway dans un objet Élément de chemin OpenAPI. Cet objet peut coexister avec d’autres objets Opération et attrape toute méthode HTTP non déclarée explicitement.

Le tableau suivant répertorie les propriétés étendues par API Gateway. Pour les autres propriétés Opération OpenAPI, consultez la spécification OpenAPI.

Nom de la propriété Type Description
isDefaultRoute Boolean Spécifie si une route est la route $default. Prise en charge uniquement pour les API HTTP. Pour en savoir plus, consultez la section Création de routes pour HTTP APIs dans API Gateway.
x-amazon-apigateway-integration Objet x-amazon-apigateway-integration Spécifie l’intégration de la méthode au backend. Cette est une propriété étendue de l’objet opération OpenAPI. L’intégration peut être de type AWS, AWS_PROXY, HTTP, HTTP_PROXY ou MOCK.

Exemples x-amazon-apigateway-any-method

L’exemple suivant intègre la méthode ANY sur une ressource proxy, {proxy+}, avec une fonction 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"
        }

L’exemple suivant crée une route $default pour une API HTTP qui s’intègre avec une fonction 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
      }
   }
}