x-amazon-apigateway-integration Objekt

Gibt die Details der für diese Methode verwendeten Backend-Integration an. Diese Erweiterung ist eine erweiterte Eigenschaft des Open API Operation-Objekts. Das Ergebnis ist ein APIGateway-Integrationsobjekt.

x-amazon-apigateway-integration Beispiele

Für HTTP APIs können Sie Integrationen im Abschnitt Komponenten Ihrer API Open-Definition definieren. Weitere Informationen hierzu finden Sie unter x-amazon-apigateway-integrations Objekt.

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

Im folgenden Beispiel wird eine Integration mit einer Lambda-Funktion erstellt. Zu Demonstrationszwecken wird davon ausgegangen, dass die in requestTemplates und responseTemplates den folgenden Beispielen gezeigten Beispiel-Mapping-Vorlagen für die folgende JSON -formatierte Nutzlast gelten: { "name":"value_1", "key":"value_2", "redirect": {"url" :"..."} } zur Generierung einer JSON Ausgabe von { "stage":"value_1", "user-id":"value_2" } oder einer Ausgabe von. XML <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'"
            }
        }
    }
}
                

Beachten Sie, dass doppelte Anführungszeichen („) für die JSON Zeichenfolge in den Mapping-Vorlagen mit Zeichenketten-Escape-Zeichen (\“) versehen werden müssen.