【发布时间】：2016-11-08 08:20:47
【问题描述】：
我正在为 AWS API Gateway 编写一个 swagger 文件。我必须使用一个文本块来集成每个端点。这就是单个端点当前的样子
'/products/{productId}':
get:
tags:
- product
summary: Get detailed information about a product
consumes:
- application/json
produces:
- application/json
parameters:
- name: productId
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
type: array
items:
$ref: '#/definitions/product'
'404':
description: product not found
schema:
type: array
items:
$ref: '#/definitions/product'
x-amazon-apigateway-integration:
requestTemplates:
application/json: >
## See
http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
## This template will pass through all parameters including path,
querystring, header, stage variables, and context through to the
integration endpoint via the body/payload
#set($allParams = $input.params())
{
"body-json" : $input.json('$'),
"params" : {
#foreach($type in $allParams.keySet())
#set($params = $allParams.get($type))
"$type" : {
#foreach($paramName in $params.keySet())
"$paramName" : "$util.escapeJavaScript($params.get($paramName))"
#if($foreach.hasNext),#end
#end
}
#if($foreach.hasNext),#end
#end
},
"stage-variables" : {
#foreach($key in $stageVariables.keySet())
"$key" : "$util.escapeJavaScript($stageVariables.get($key))"
#if($foreach.hasNext),#end
#end
},
"context" : {
"account-id" : "$context.identity.accountId",
"api-id" : "$context.apiId",
"api-key" : "$context.identity.apiKey",
"authorizer-principal-id" : "$context.authorizer.principalId",
"caller" : "$context.identity.caller",
"cognito-authentication-provider" : "$context.identity.cognitoAuthenticationProvider",
"cognito-authentication-type" : "$context.identity.cognitoAuthenticationType",
"cognito-identity-id" : "$context.identity.cognitoIdentityId",
"cognito-identity-pool-id" : "$context.identity.cognitoIdentityPoolId",
"http-method" : "$context.httpMethod",
"stage" : "$context.stage",
"source-ip" : "$context.identity.sourceIp",
"user" : "$context.identity.user",
"user-agent" : "$context.identity.userAgent",
"user-arn" : "$context.identity.userArn",
"request-id" : "$context.requestId",
"resource-id" : "$context.resourceId",
"resource-path" : "$context.resourcePath"
}
}
uri: >-
arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:87126xxxxxxx:function:lambdatest_v3/invocations
passthroughBehavior: never
responses:
default:
statusCode: '200'
httpMethod: POST
type: aws
关于 x-amazon-apigateway-integration 的部分需要重复，因为它适用于每条路径。我怎么能不每次都写。是否有可能有一个字符串定义至少包含关于application/json 的部分？
我尝试创建一个字符串定义，但它在 aws import 上不起作用：
definitions:
MyAPI:
type: string
default: >
#Magic
#set($allParams = $input.params())
{
"body-json" : $input.json('$'),
"params" : {
#foreach($type in $allParams.keySet())
#set($params = $allParams.get($type))
"$type" : {
#foreach($paramName in $params.keySet())
"$paramName" : "$util.escapeJavaScript($params.get($paramName))"
#if($foreach.hasNext),#end
#end
}
#if($foreach.hasNext),#end
#end
},
"stage-variables" : {
#foreach($key in $stageVariables.keySet())
"$key" : "$util.escapeJavaScript($stageVariables.get($key))"
#if($foreach.hasNext),#end
#end
},
"context" : {
"account-id" : "$context.identity.accountId",
"api-id" : "$context.apiId",
"api-key" : "$context.identity.apiKey",
"authorizer-principal-id" : "$context.authorizer.principalId",
"caller" : "$context.identity.caller",
"cognito-authentication-provider" : "$context.identity.cognitoAuthenticationProvider",
"cognito-authentication-type" : "$context.identity.cognitoAuthenticationType",
"cognito-identity-id" : "$context.identity.cognitoIdentityId",
"cognito-identity-pool-id" : "$context.identity.cognitoIdentityPoolId",
"http-method" : "$context.httpMethod",
"stage" : "$context.stage",
"source-ip" : "$context.identity.sourceIp",
"user" : "$context.identity.user",
"user-agent" : "$context.identity.userAgent",
"user-arn" : "$context.identity.userArn",
"request-id" : "$context.requestId",
"resource-id" : "$context.resourceId",
"resource-path" : "$context.resourcePath"
}
}
然后在路径中：
x-amazon-apigateway-integration:
requestTemplates:
application/json:
$ref: '#/definitions/MyAPI'
uri: >-
arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:8712xxxxxxxx:function:lambdaTest_v3/invocations
passthroughBehavior: never
responses:
default:
statusCode: '200'
httpMethod: POST
type: aws
【问题讨论】：
-
这可能无法直接回答您的问题，但是您知道您可以从 API Gateway 阶段将其导出为 JSON 吗？
-
是的，我正在尝试做相反的事情。我有一个版本控制的 swagger 文件，并且我有一个系统可以使用
aws apigateway import-rest-api将更新到 swagger 文件导入 API 网关。由于将针对所有端点重复网关集成，因此我不想再次重复相同的块。我不知道该怎么做。现在，我在部署过程中添加了集成段落。 -
啊，好吧，对不起，我误解了你在做什么。我还没有使用 import api 方法，所以我可能无法在这里提供帮助。
标签： amazon-web-services swagger aws-lambda swagger-2.0