如何使用AWS CDK（TypeScript）复现API Gateway GET方法请求的URL查询字符串参数配置

我完全懂你的困扰——在CDK里配置API Gateway的Method Request参数时，很容易和集成请求的配置搞混，而且官方文档里的示例大多聚焦在集成侧，确实容易让人摸不着头脑。其实你要找的配置就在MethodOptions接口里，只是它的属性命名和控制台的操作入口对应得有点间接，我来给你一步步拆解怎么复现你在控制台完成的配置。

核心配置逻辑 #

在CDK中，方法请求的查询字符串参数是通过addMethod方法的第三个参数（即MethodOptions）里的requestParameters属性来定义的。这个属性的键需要遵循固定格式：method.request.querystring.{你的参数名}，值为布尔值——true表示该参数是必填项，false表示可选。

如果需要API Gateway自动验证这些参数（比如必填参数缺失时返回400错误），还要配合开启requestValidatorOptions里的参数验证开关。

完整TypeScript代码示例 #

下面是一个可直接运行的示例，包含RestApi创建、Lambda集成，以及关键的查询参数配置：

import { RestApi, LambdaIntegration, MethodOptions } from 'aws-cdk-lib/aws-apigateway';
import { Function, Runtime, Code } from 'aws-cdk-lib/aws-lambda';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class ApiQueryParamStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    // 1. 创建示例Lambda函数（作为API的集成目标）
    const demoLambda = new Function(this, 'DemoLambda', {
      runtime: Runtime.NODEJS_18_X,
      handler: 'index.handler',
      code: Code.fromInline(`
        exports.handler = async (event) => {
          return {
            statusCode: 200,
            body: JSON.stringify({
              message: '参数接收成功',
              传入的查询参数: event.queryStringParameters
            })
          };
        };
      `)
    });

    // 2. 创建RestApi实例
    const api = new RestApi(this, 'DemoApi', {
      restApiName: '查询参数演示API',
      description: '通过CDK配置Method Request查询参数的示例'
    });

    // 3. 添加API资源（比如/info路径）
    const infoResource = api.root.addResource('info');

    // 4. 配置GET方法及查询参数（重点部分）
    const methodOptions: MethodOptions = {
      // 定义方法请求的查询字符串参数
      requestParameters: {
        'method.request.querystring.username': true, // 必填参数
        'method.request.querystring.region': false   // 可选参数
      },
      // 启用请求参数验证，确保必填参数存在
      requestValidatorOptions: {
        validateRequestParameters: true,
        requestValidatorName: 'QueryParamValidator'
      }
    };

    // 将方法与Lambda集成，并应用上面的配置
    infoResource.addMethod('GET', new LambdaIntegration(demoLambda), methodOptions);
  }
}

关键细节说明 #

• 参数格式：一定要严格遵循method.request.querystring.{paramName}的键格式，这是API Gateway的内部命名规范，CDK通过这个格式来识别你要配置的是方法请求的查询参数，而非集成请求的参数。
• 必填/可选控制：布尔值true会让API Gateway在请求缺少该参数时直接返回400错误（前提是开启了参数验证），false则允许请求不带该参数。
• 参数验证：如果不需要自动验证，可以省略requestValidatorOptions，但建议开启它来减少后端Lambda的无效请求处理。

这样配置后，部署CDK栈就能得到和你在AWS控制台手动配置完全一致的Method Request查询参数了。

内容的提问来源于stack exchange，提问作者FilipKamenar