如何在AWS ECS容器的Node.js项目中获取主机IP用于Swagger

针对AWS ECS容器部署的Node.js API，以下几种方案可以实现Swagger动态显示当前主机IP/访问地址：

方案1：利用ECS任务元数据获取容器信息 #

ECS容器可通过内置的元数据端点获取自身网络信息，适合需要自动获取容器私有IP的场景（默认容器有权限访问该端点）：

const axios = require('axios');

async function getECSHost() {
  // ECS元数据V4端点（需ECS平台版本≥1.4.0）
  const metadataUrl = 'http://169.254.170.2/v4/latest/';
  try {
    const res = await axios.get(metadataUrl);
    // 获取容器私有IP
    const privateIp = res.data.NetworkInterfaces[0].PrivateIpAddresses[0].PrivateIpAddress;
    // 如果通过ALB对外提供服务，可结合环境变量配置公网地址
    return process.env.ALB_PUBLIC_HOST || privateIp;
  } catch (err) {
    // 失败时 fallback 到环境变量或默认值
    return process.env.API_HOST || 'localhost:3000';
  }
}

将获取到的地址动态注入Swagger配置（以swagger-jsdoc为例）：

const swaggerJsdoc = require('swagger-jsdoc');

async function initSwagger() {
  const host = await getECSHost();
  const swaggerSpec = swaggerJsdoc({
    definition: {
      openapi: '3.0.0',
      info: {
        title: '你的API文档',
        version: '1.0.0'
      },
      host: host,
      schemes: ['http', 'https'] // 根据实际协议调整
    },
    apis: ['./routes/*.js'] // 你的API路由文件路径
  });
  return swaggerSpec;
}

方案2：通过ECS环境变量注入固定访问地址 #

如果你的API通过ALB/NLB对外提供服务，直接在ECS任务定义中配置环境变量是更简单的方式：

1. 进入ECS任务定义，添加环境变量API_HOST，值设为ALB的公网域名/IP（如alb-xxx.us-east-1.elb.amazonaws.com）
2. 在Node.js代码中直接读取该变量设置Swagger：

const swaggerOptions = {
  definition: {
    openapi: '3.0.0',
    info: { /* 文档基本信息 */ },
    host: process.env.API_HOST || 'localhost:3000',
    schemes: ['https']
  },
  apis: ['./routes/*.js']
};
const swaggerSpec = swaggerJsdoc(swaggerOptions);

方案3：从请求头获取真实访问IP（单容器直接暴露场景） #

若容器直接绑定公网IP（不推荐生产环境），可在Swagger页面请求时动态获取客户端看到的真实IP：

const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerJsdoc = require('swagger-jsdoc');

const app = express();
// 若使用反向代理（如ALB），需开启信任代理才能获取真实客户端IP
app.set('trust proxy', true);

app.use('/api-docs', (req, res, next) => {
  const realIp = req.ip || req.connection.remoteAddress;
  const swaggerSpec = swaggerJsdoc({
    definition: {
      openapi: '3.0.0',
      info: { /* 文档基本信息 */ },
      host: realIp,
      schemes: ['http']
    },
    apis: ['./routes/*.js']
  });
  req.swaggerDoc = swaggerSpec;
  next();
}, swaggerUi.serve, swaggerUi.setup());

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