x-amazon-apigateway-integration 对象

指定用于该方法的后端集成的详细信息。此扩展是 OpenAPI 操作对象的扩展属性。结果是 API Gateway 集成对象。

x-amazon-apigateway-integration 示例

对于 HTTP API，您可以在 OpenAPI 定义的组件部分中定义集成。要了解更多信息，请参阅“x-amazon-apigateway-integrations 对象”。

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

以下示例创建了与 Lambda 函数的集成。出于演示目的，假定 requestTemplates 中显示的示例映射模板和下面示例中的 responseTemplates 适用于以下 JSON 格式的负载：{ "name":"value_1", "key":"value_2", "redirect": {"url" :"..."} }，以生成 { "stage":"value_1", "user-id":"value_2" } 的 JSON 输出或 <stage>value_1</stage> 的 XML 输出。

"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'"
            }
        }
    }
}
                

注意，映射模板中 JSON 字符串的双引号 (") 必须是转义字符串 (\")。