如何在CDK中为API Gateway响应添加额外属性response_id？

有几种可行的方式实现需求，以下是常见的两种方案：

方案一：在Lambda集成函数中直接添加属性 #

如果你的API Gateway使用Lambda集成，最简单直接的方式是在Lambda处理逻辑中，给返回的响应体手动添加response_id属性。你可以自定义response_id的生成规则（比如UUID、请求ID关联值等）。

示例Node.js Lambda代码：

exports.handler = async (event) => {
  // 执行业务逻辑，获取核心响应数据
  const coreResponse = {
    message: "操作成功",
    result: {}
  };

  // 添加response_id，这里使用Node.js内置crypto模块生成UUID
  const finalResponse = {
    ...coreResponse,
    response_id: require('crypto').randomUUID()
  };

  return {
    statusCode: 200,
    body: JSON.stringify(finalResponse),
    headers: {
      'Content-Type': 'application/json'
    }
  };
};

这种方式的优势是灵活可控，你可以根据业务场景调整response_id的生成逻辑，且不需要额外配置API Gateway。

方案二：通过API Gateway映射模板统一添加属性 #

如果需要给多个API方法统一添加response_id，且不想修改Lambda代码，可以利用API Gateway的集成响应映射模板来转换响应体。在CDK中可以直接配置该模板，使用API Gateway内置的变量（比如请求ID）作为response_id。

示例CDK TypeScript代码：

import * as cdk from 'aws-cdk-lib';
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import { Construct } from 'constructs';

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

    // 创建Lambda函数
    const demoLambda = new lambda.Function(this, 'DemoLambda', {
      runtime: lambda.Runtime.NODEJS_18_X,
      handler: 'index.handler',
      code: lambda.Code.fromAsset('lambda')
    });

    // 创建REST API
    const demoApi = new apigateway.RestApi(this, 'DemoApi');

    // 配置Lambda集成
    const lambdaIntegration = new apigateway.LambdaIntegration(demoLambda);

    // 添加API资源与方法
    const demoResource = demoApi.root.addResource('demo');
    demoResource.addMethod('GET', lambdaIntegration, {
      // 定义方法响应
      methodResponses: [{
        statusCode: '200',
        responseModels: {
          'application/json': apigateway.Model.EMPTY_MODEL
        }
      }],
      // 配置集成响应与映射模板
      integrationResponses: [{
        statusCode: '200',
        responseTemplates: {
          'application/json': `
            #set($inputRoot = $input.path('$'))
            {
              "response_id": "$context.requestId",
              #foreach($key in $inputRoot.keySet())
                "$key": "$inputRoot.get($key)"#if($foreach.hasNext),#end
              #end
            }
          `
        }
      }]
    });
  }
}

模板说明： #

• $context.requestId是API Gateway的内置变量，代表当前请求的唯一ID，可直接用作response_id
• 模板会遍历Lambda返回的原响应体所有属性，与response_id合并后返回

如果原响应是数组类型，可调整模板格式：

{
  "response_id": "$context.requestId",
  "data": $input.json('$')
}

这种方式的优势是无需修改业务代码，就能批量给API响应统一添加属性，适合多接口统一规范的场景。

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