aws-cdk.aws-apigateway 1.6.1

Amazon API网关构造库

amazon api网关是一个完全托管的服务，它使开发人员很容易 以任何规模发布、维护、监视和保护api。创建一个api 从后端服务访问数据、业务逻辑或功能，如 作为运行在AmazonElasticComputeCloud（AmazonEC2）上的应用程序，代码 在AWS Lambda或任何Web应用程序上运行。

定义API

api被定义为资源和方法的层次结构。添加资源和 addMethod可用于构建此层次结构。根资源是 api.root

例如，下面的代码定义了一个api，该api包含以下http 端点：any/，get/books，post/books，get/books/{book_id}，delete/books/{book_id}

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

aws lambda支持的api

一个非常常见的做法是使用amazon api网关和aws lambda作为 后端集成。lambdarestapi的构造使它变得简单：

下面的代码定义了一个rest api，它将所有请求路由到 指定的aws lambda函数：

constbackend=newlambda.Function(...);newapigateway.LambdaRestApi(this,'myapi',{handler: backend,});

您还可以提供proxy:false，在这种情况下，您必须显式地 定义API模型：

constbackend=newlambda.Function(...);constapi=newapigateway.LambdaRestApi(this,'myapi',{handler: backend,proxy: false});constitems=api.root.addResource('items');items.addMethod('GET');// GET /itemsitems.addMethod('POST');// POST /itemsconstitem=items.addResource('{item}');item.addMethod('GET');// GET /items/{item}// the default integration for methods is "handler", but one can// customize this behavior per method or even a sub path.item.addMethod('DELETE',newapigateway.HttpIntegration('http://amazon.com'));

集成目标

方法与后端集成关联，当 方法被调用。API网关支持以下集成：

• mockintegration-可用于测试API。这是默认值 如果未指定集成。
• lambdaintegration-可用于调用aws lambda函数。
• awsintegration-可用于调用任意aws服务api。
• httpintegration-可用于调用http端点。

下面的示例演示如何将get/book/{book\u id}方法集成到 aws lambda函数：

constgetBookHandler=newlambda.Function(...);constgetBookIntegration=newapigateway.LambdaIntegration(getBookHandler);book.addMethod('GET',getBookIntegration);

可以选择指定集成选项：

constgetBookIntegration=newapigateway.LambdaIntegration(getBookHandler,{contentHandling: apigateway.ContentHandling.CONVERT_TO_TEXT,// convert to base64credentialsPassthrough: true,// use caller identity to invoke the function});

添加方法时，可以选择指定方法选项：

book.addMethod('GET',getBookIntegration,{authorizationType: apigateway.AuthorizationType.IAM,apiKeyRequired: true});

下面的示例演示如何在使用计划中使用API密钥：

consthello=newlambda.Function(this,'hello',{runtime: lambda.Runtime.NODEJS_10_X,handler:'hello.handler',code: lambda.Code.fromAsset('lambda')});constapi=newapigateway.RestApi(this,'hello-api',{});constintegration=newapigateway.LambdaIntegration(hello);constv1=api.root.addResource('v1');constecho=v1.addResource('echo');constechoMethod=echo.addMethod('GET',integration,{apiKeyRequired: true});constkey=api.addApiKey('ApiKey');constplan=api.addUsagePlan('UsagePlan',{name:'Easy',apiKey: key});plan.addApiStage({stage: api.deploymentStage,throttle:[{method: echoMethod,throttle:{rateLimit: 10,burstLimit: 2}}]});

使用型号

当您使用不是代理集成的lambda集成时， 必须为请求、响应和集成定义模型和映射。

consthello=newlambda.Function(this,'hello',{runtime: lambda.Runtime.NODEJS_10_X,handler:'hello.handler',code: lambda.Code.fromAsset('lambda')});constapi=newapigateway.RestApi(this,'hello-api',{});constresource=api.root.addResource('v1');

您可以在集成上定义更多参数来优化api网关的行为

constintegration=newLambdaIntegration(hello,{proxy: false,requestParameters:{// You can define mapping parameters from your method to your integration// - Destination parameters (the key) are the integration parameters (used in mappings)// - Source parameters (the value) are the source request parameters or expressions// @see: https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html'integration.request.querystring.who':'method.request.querystring.who'},allowTestInvoke: true,requestTemplates:{// You can define a mapping that will build a payload for your integration, based//  on the integration parameters that you have specified// Check: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html'application/json':JSON.stringify({action:'sayHello',pollId:"$util.escapeJavaScript($input.params('who'))"})},// This parameter defines the behavior of the engine is no suitable response template is foundpassthroughBehavior: PassthroughBehavior.NEVER,integrationResponses:[{// Successful response from the Lambda function, no filter defined//  - the selectionPattern filter only tests the error message// We will set the response status code to 200statusCode:"200",responseTemplates:{// This template takes the "message" result from the Lambda function, adn embeds it in a JSON response// Check https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html'application/json':JSON.stringify({state:'ok',greeting:'$util.escapeJavaScript($input.body)'})},responseParameters:{// We can map response parameters// - Destination parameters (the key) are the response parameters (used in mappings)// - Source parameters (the value) are the integration response parameters or expressions'method.response.header.Content-Type':"'application/json'",'method.response.header.Access-Control-Allow-Origin':"'*'",'method.response.header.Access-Control-Allow-Credentials':"'true'"}},{// For errors, we check if the error message is not empty, get the error dataselectionPattern:'(\n|.)+',// We will set the response status code to 200statusCode:"400",responseTemplates:{'application/json':JSON.stringify({state:'error',message:"$util.escapeJavaScript($input.path('$.errorMessage'))"})},responseParameters:{'method.response.header.Content-Type':"'application/json'",'method.response.header.Access-Control-Allow-Origin':"'*'",'method.response.header.Access-Control-Allow-Credentials':"'true'"}}]});

您可以为响应（和请求）定义模型

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constapi=newapigateway.RestApi(this,'books-api');api.root.addMethod('ANY');constbooks=api.root.addResource('books');books.addMethod('GET');books.addMethod('POST');constbook=books.addResource('{book_id}');book.addMethod('GET');book.addMethod('DELETE');

constbackend=newlambda.Function(...);newapigateway.LambdaRestApi(this,'myapi',{handler: backend,});

constbackend=newlambda.Function(...);newapigateway.LambdaRestApi(this,'myapi',{handler: backend,});