@faapi/faapi
v6.47.0
Published
函数即接口 - Function as API
Maintainers
tlnuReadme
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 仓库。