@faapi/faapi

中文文档
7.21.0发布于 2026/11/01MITTypeScriptES Module构建来源已验证

函数即接口 - Function as API

原始使用文档
文档目录5 节
  1. 安装
  2. 快速开始
  3. 核心能力
  4. 文档
  5. 许可证

faapi

函数即接口 — Function as API

faapi 是一个 Node.js 框架,核心理念是"函数即接口"。编写普通 TypeScript 函数即可暴露为 HTTP / WebSocket 接口,类型校验由 TypeScript AST 自动生成,无需手写 schema。

安装

pnpm add @faapi/faapi
# 或
npm install @faapi/faapi

要求 Node.js >= 24。faapi 仅支持 ESM(type: "module"),不提供 CJS 产物。

快速开始

// api/user/handler.ts
export interface Query {
  page: number;
  pageSize: number;
}

export function GET(query: Query) {
  return { page: query.page, pageSize: query.pageSize };
}
# 启动 dev server
npx faapi

访问 http://localhost:3000/api/user?page=1&pageSize=10 即可。

# 生产部署
faapi build                # 编译 .ts → dist/,生成路由清单 + schema + dist/main.js
node dist/main             # 启动生产服务器

核心能力

  • 函数即接口:导出 GET/POST 等函数即声明路由
  • AST 类型校验:TypeScript Compiler API 自动生成运行时校验
  • 洋葱模型中间件:(ctx, next) => {}
  • 依赖注入:注入器按参数名匹配 handler 参数
  • WebSocket 路由:导出 WS 函数声明
  • SSE 流式响应:ctx.sse() 流式推送(LLM 输出、通知推送)
  • 响应压缩:compression: true,gzip/deflate/br 协商,SSE 自动跳过
  • ETag/304 协商:etag: true,GET/HEAD 弱 ETag 自动生成与协商
  • 优雅停机:SIGTERM/SIGINT 默认注册,drain 在途请求(FAAPI_SHUTDOWN_TIMEOUT_MS 可调)
  • app 级注册表:tool/agent/skill 注册表随 app 实例创建与销毁,多 app 同进程隔离
  • SSE 流式响应:ctx.sse() 推送
  • 动态路由:[id] / [...slug] / (group)
  • MCP 集成:LLM 可查询路由 schema
  • 配置文件:faapi.config.ts 统一响应格式、全局错误处理、生命周期钩子、全局中间件/注入器
  • ESM only

文档

完整文档见 GitHub 仓库。

许可证

MIT

版本与发布记录

@faapi/faapi 共发布 145 个版本,首次发布于 2026/06/28;过去 12 个月发布了 145 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.21.0latest2026/11/012 天前
7.20.12026/10/303 天前
7.20.02026/10/304 天前
7.19.02026/10/304 天前
7.18.02026/10/304 天前
7.17.02026/10/294 天前

其他发布通道:canary → 2.0.1-canary.0。

关于 @faapi/faapi 的常见问题

@faapi/faapi 是什么?

i -作为API使用

如何安装 @faapi/faapi?

在项目目录运行 npm install @faapi/faapi,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4.4.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 faapi,可以用 npx faapi 直接运行。

@faapi/faapi 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@faapi/faapi 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@faapi/faapi 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@faapi/faapi 可以商用吗?

@faapi/faapi 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@faapi/faapi 还在维护吗?

最新版本 7.21.0 发布于 2026/11/01(2 天前);至今共发布 145 个版本,其中过去 12 个月发布了 145 个;首次发布于 2026/06/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。