如何从NestJs向Vue（及任意前端）应用合理共享API类型

核心思路：利用NestJS的元数据反射机制 #

NestJS本身依赖reflect-metadata存储路由、DTO、请求方法等元数据，你可以编写脚本直接提取这些信息生成TypeScript接口：

• 遍历后端所有控制器类，通过Reflect.getMetadata获取控制器的基础路由前缀（来自@Controller装饰器）
• 提取每个路由处理方法的请求类型（GET/POST等，对应@Get/@Post等装饰器的元数据）
• 获取方法绑定的参数类型，比如@Body()对应的DTO类、@Query()的参数类型
• 读取方法的返回类型（通过design:returntype元数据）

示例代码片段：

import { Reflector } from '@nestjs/core';
import { CONTROLLER_METADATA, ROUTE_ARGS_METADATA, ROUTE_METADATA, RequestMethod } from '@nestjs/common/constants';

const reflector = new Reflector();
// 导入你的所有控制器类
const controllers = [UserController, PostController];

controllers.forEach(controller => {
  const basePath = reflector.get(CONTROLLER_METADATA, controller);
  const proto = controller.prototype;
  
  Object.getOwnPropertyNames(proto)
    .filter(name => name !== 'constructor')
    .forEach(methodName => {
      const method = proto[methodName];
      // 获取路由路径
      const routePath = reflector.get(ROUTE_METADATA, method);
      // 获取请求方法（GET/POST等）
      const requestMethod = reflector.get(RequestMethod, method);
      // 获取Body参数对应的DTO类型
      const bodyArgs = reflector.get(ROUTE_ARGS_METADATA, method)?.[0];
      const bodyDtoType = bodyArgs?.type;
      // 获取返回类型
      const returnType = Reflect.getMetadata('design:returntype', method);
      
      // 这里可以根据收集到的信息生成TS类型
    });
});

结合Monorepo的类型共享优势 #

因为已经实现DTO跨端共享，生成接口时直接引用共享包中的类型即可，不需要重复定义。比如生成的请求体类型直接导入@your-monorepo/shared中的DTO，返回类型同理，确保前后端类型完全一致。

生成TS接口或封装API调用函数 #

收集完路由信息后，通过字符串拼接或模板引擎生成TS文件：

• 为每个路由生成请求参数/响应类型的定义
• 生成统一的API路由类型映射表
• 甚至可以自动生成带类型提示的API调用函数，直接在Vue项目中使用

示例生成的代码：

import { CreateUserDto, UserDto } from '@your-monorepo/shared';

// 请求类型定义
export type CreateUserRequest = {
  method: 'POST';
  path: '/users';
  body: CreateUserDto;
};

export type GetUserByIdRequest = {
  method: 'GET';
  path: '/users/:id';
  params: { id: string };
};

// 响应类型映射
export type ApiResponse<T> = 
  T extends CreateUserRequest ? UserDto :
  T extends GetUserByIdRequest ? UserDto :
  never;

// 带类型提示的API调用函数
export async function apiCall<T>(request: T): Promise<ApiResponse<T>> {
  // 基于request的method、path、body/params发起请求
  const { method, path, ...rest } = request;
  const response = await fetch(`/api${path}`, {
    method,
    body: 'body' in rest ? JSON.stringify(rest.body) : undefined,
  });
  return response.json();
}

自动化集成 #

把生成脚本加入Monorepo的构建流程，比如在后端编译完成后自动执行，生成最新的API类型文件，前端直接引用即可。也可以封装成NestJS自定义CLI命令，手动触发更新。

另外，你可以参考@nestjs/swagger的实现逻辑——它也是通过提取元数据生成文档，完全可以借鉴这套逻辑来适配TypeScript类型生成需求。

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