Azure上NestJS Function App仅显示单个Http触发器问题排查

部署在Azure上的NestJS应用仅显示main函数，无法看到应用内的所有端点。虽然所有端点均可正常访问，但对接API Management（APIM）时，APIM仅能识别到这一个main端点。此前使用C#开发时无需修改function.json即可自动识别所有函数，请问为何该Function App仅显示一个Http函数？需要修改哪些配置才能列出所有函数？

问题原因 #

当前你使用的是单函数入口模式：NestJS的所有路由都通过这一个Azure Function进行转发，Azure Functions本身只会识别代码中导出的default函数（即你的主函数），而NestJS控制器中定义的各个端点属于应用内部的路由规则，Azure Functions并不感知这些端点的存在。

C#开发时能自动识别所有函数，是因为Azure Functions对C#有特定的集成支持（比如通过属性路由自动生成多个函数的function.json），但NestJS的@nestjs/azure-func-http适配器默认采用单入口的方式，将整个Nest应用包裹在一个Azure Function中。

解决方案 #

方案1：生成OpenAPI文档，让APIM自动导入所有端点（推荐） #

通过NestJS的Swagger插件生成标准的OpenAPI文档，再在APIM中导入该文档，即可自动识别所有端点。步骤如下：

1. 安装Swagger依赖

npm install @nestjs/swagger swagger-ui-express

2. 修改main.azure.ts，启用Swagger文档生成

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';

export async function createApp(): Promise<INestApplication> {
  const app = await NestFactory.create(AppModule);
  app.setGlobalPrefix('api');
  app.enableCors(corsOptions);

  app.use(json({ limit: '50mb' }));
  app.use(urlencoded({ extended: true, limit: '50mb' }));

  // 配置Swagger文档
  const swaggerConfig = new DocumentBuilder()
    .setTitle('你的API名称')
    .setDescription('API功能描述')
    .setVersion('1.0')
    .build();
  const apiDocument = SwaggerModule.createDocument(app, swaggerConfig);
  SwaggerModule.setup('swagger', app, apiDocument); // 文档访问路径为 /swagger

  app.enableShutdownHooks();

  await app.init();
  return app;
}

3. 部署应用后，访问https://<你的FunctionApp域名>/api/swagger/json获取OpenAPI文档。

4. 在APIM中导入该文档：进入APIM的“API”页面，选择“从OpenAPI导入”，填入上述文档URL，即可自动创建所有端点的映射。

方案2：拆分多个Azure Function（不推荐） #

如果一定要让Azure Functions显示多个独立的函数，需要为每个Nest端点创建单独的函数文件和function.json配置，但这会破坏NestJS的路由统一管理，维护成本较高。示例如下：

• 为AppController的getHelloWorldFromApp端点创建单独的函数文件app-get/index.ts：

import { Context, HttpRequest } from '@azure/functions';
import { AzureHttpAdapter } from '@nestjs/azure-func-http';
import { createApp } from '../src/main.azure';

export default function (context: Context, req: HttpRequest) {
  AzureHttpAdapter.handle(createApp, context, req);
}

• 对应的function.json配置：

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get"],
      "route": "api/APP"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    }
  ]
}

这种方式需要手动为每个端点重复配置，仅在特殊场景下使用。

总结 #

推荐使用方案1，通过OpenAPI文档让APIM自动识别所有端点，既保留NestJS的开发优势，又能满足APIM的对接需求。

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