如何引用OpenAPI创建的API Gateway资源配置Terraform集成至Step Functions

刚好碰到过类似的场景，当你用OpenAPI规范让Terraform自动生成API Gateway资源时，确实没法直接像手动定义资源那样引用ID，但有几个靠谱的方法能搞定这个问题：

方法1：用aws_api_gateway_resource数据源精准查询资源 #

这是最直接的方式——既然你知道OpenAPI里定义的资源路径，就可以通过REST API ID、父资源ID（通常是API的根资源ID）和路径片段来查询自动生成的资源ID。

举个例子，假设你的OpenAPI里定义了/orders资源，对应的Terraform代码可以这么写：

# 查询自动生成的/orders资源
data "aws_api_gateway_resource" "orders" {
  rest_api_id = aws_api_gateway_rest_api.my_api.id
  parent_id   = aws_api_gateway_rest_api.my_api.root_resource_id
  path_part   = "orders"
}

# 创建指向Step Functions的集成
resource "aws_api_gateway_integration" "orders_sfn_integration" {
  rest_api_id             = aws_api_gateway_rest_api.my_api.id
  resource_id             = data.aws_api_gateway_resource.orders.id
  http_method             = "POST" # 要和OpenAPI里定义的方法一致
  type                    = "AWS"
  integration_http_method = "POST"
  uri                     = aws_sfn_state_machine.order_processor.arn
  credentials             = aws_iam_role.api_gateway_sfn_exec_role.arn

  # 适配Step Functions的请求模板
  request_templates = {
    "application/json" = <<EOF
{
  "input": "$util.escapeJavaScript($input.json('$'))",
  "stateMachineArn": "${aws_sfn_state_machine.order_processor.arn}"
}
EOF
  }
}

如果是嵌套资源（比如/orders/{orderId}），需要先查询父资源/orders，再以父资源ID作为parent_id查询子资源：

data "aws_api_gateway_resource" "orders" {
  rest_api_id = aws_api_gateway_rest_api.my_api.id
  parent_id   = aws_api_gateway_rest_api.my_api.root_resource_id
  path_part   = "orders"
}

data "aws_api_gateway_resource" "order_detail" {
  rest_api_id = aws_api_gateway_rest_api.my_api.id
  parent_id   = data.aws_api_gateway_resource.orders.id
  path_part   = "{orderId}"
}

方法2：解析本地OpenAPI文件动态生成资源引用 #

如果你的OpenAPI规范是本地JSON文件，还可以用Terraform的file和jsondecode函数解析文件，自动提取所有资源路径，批量创建数据源和集成，适合资源较多的场景：

# 解析本地OpenAPI规范
locals {
  openapi_spec = jsondecode(file("${path.module}/your_openapi_spec.json"))
  # 提取所有一级资源的路径片段和对应的HTTP方法
  api_resources = [
    for path, methods in local.openapi_spec.paths : {
      path_part   = split("/", path)[1] # 从"/orders"提取"orders"
      http_method = keys(methods)[0]    # 假设每个资源只定义了一个方法，可根据实际调整
    }
  ]
}

# 批量查询自动生成的资源
data "aws_api_gateway_resource" "auto_resources" {
  count       = length(local.api_resources)
  rest_api_id = aws_api_gateway_rest_api.my_api.id
  parent_id   = aws_api_gateway_rest_api.my_api.root_resource_id
  path_part   = local.api_resources[count.index].path_part
}

# 批量创建Step Functions集成
resource "aws_api_gateway_integration" "sfn_integrations" {
  count                   = length(local.api_resources)
  rest_api_id             = aws_api_gateway_rest_api.my_api.id
  resource_id             = data.aws_api_gateway_resource.auto_resources[count.index].id
  http_method             = local.api_resources[count.index].http_method
  type                    = "AWS"
  integration_http_method = "POST"
  uri                     = aws_sfn_state_machine.main_machine.arn
  credentials             = aws_iam_role.api_gateway_sfn_role.arn

  request_templates = {
    "application/json" = <<EOF
{
  "input": "$util.escapeJavaScript($input.json('$'))",
  "stateMachineArn": "${aws_sfn_state_machine.main_machine.arn}"
}
EOF
  }
}

方法3：利用aws_api_gateway_rest_api的resources属性过滤 #

部分版本的Terraform中，aws_api_gateway_rest_api资源会导出resources列表，包含所有自动创建的资源信息。你可以用for表达式过滤出目标资源：

locals {
  # 从API的资源列表中过滤出path_part为"orders"的资源
  orders_resource = [
    for res in aws_api_gateway_rest_api.my_api.resources : res
    if res.path_part == "orders"
  ][0]
}

# 创建集成时直接引用本地变量
resource "aws_api_gateway_integration" "orders_sfn" {
  rest_api_id             = aws_api_gateway_rest_api.my_api.id
  resource_id             = local.orders_resource.id
  http_method             = "POST"
  # 其他集成配置...
}

注意事项 #

• 路径片段要和OpenAPI里的定义完全一致，AWS API Gateway的路径是大小写敏感的
• 如果资源有多个HTTP方法（比如GET、POST），需要调整代码处理多方法的情况（比如嵌套循环）
• 确保IAM角色有足够的权限让API Gateway调用Step Functions

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