x-amazon-apigateway-integration objet

Spécifie les détails de l'intégration au backend utilisée pour cette méthode. Cette extension est une propriété étendue de l'objet Open API Operation. Le résultat est un objet d'intégration API Gateway.

x-amazon-apigateway-integration exemples

En HTTP APIs effet, vous pouvez définir des intégrations dans la section des composants de votre API définition ouverte. Pour en savoir plus, consultez la section x-amazon-apigateway-integrations objet.

"x-amazon-apigateway-integration": {
    "$ref": "#/components/x-amazon-apigateway-integrations/integration1"
}

L'exemple suivant crée une intégration avec une fonction Lambda. À des fins de démonstration, les exemples de modèles responseTemplates de mappage présentés dans requestTemplates et parmi les exemples ci-dessous sont supposés s'appliquer à la charge utile JSON formatée suivante : { "name":"value_1", "key":"value_2", "redirect": {"url" :"..."} } pour générer une JSON sortie de { "stage":"value_1", "user-id":"value_2" } ou une XML sortie de. <stage>value_1</stage>

"x-amazon-apigateway-integration" : {
    "type" : "aws",
    "uri" : "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:012345678901:function:HelloWorld/invocations",
    "httpMethod" : "POST",
    "credentials" : "arn:aws:iam::012345678901:role/apigateway-invoke-lambda-exec-role",
    "requestTemplates" : {
                "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
                "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
    },
    "requestParameters" : {
        "integration.request.path.stage" : "method.request.querystring.version",
        "integration.request.querystring.provider" : "method.request.querystring.vendor"
    },
    "cacheNamespace" : "cache namespace",
    "cacheKeyParameters" : [],
    "responses" : {
        "2\\d{2}" : {
            "statusCode" : "200",
            "responseParameters" : {
                "method.response.header.requestId" : "integration.response.header.cid"
            },
            "responseTemplates" : {
                "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
                "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
            }
        },
        "302" : {
            "statusCode" : "302",
            "responseParameters" : {
                "method.response.header.Location" : "integration.response.body.redirect.url"
            }
        },
        "default" : {
            "statusCode" : "400",
            "responseParameters" : {
                "method.response.header.test-method-response-header" : "'static value'"
            }
        }
    }
}
                

Notez que les guillemets («) pour la JSON chaîne dans les modèles de mappage doivent être exempts de chaînes (\ »).