@faapi/faapi 0.0.0-canary.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 faapi contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# faapi
+
+> 函数即接口 — Function as API
+
+faapi 是一个 Node.js 框架，核心理念是"函数即接口"。编写普通 TypeScript 函数即可暴露为 HTTP / WebSocket 接口，类型校验由 TypeScript AST 自动生成，无需手写 schema。
+
+## 安装
+
+```bash
+pnpm add @faapi/faapi
+# 或
+npm install @faapi/faapi
+```
+
+要求 Node.js >= 22。
+
+## 快速开始
+
+```ts
+// app/api/user/handler.ts
+export interface Query {
+  page: number;
+  pageSize: number;
+}
+
+export function GET(query: Query) {
+  return { page: query.page, pageSize: query.pageSize };
+}
+```
+
+```bash
+# 启动 dev server
+npx faapi
+```
+
+访问 `http://localhost:3000/api/user?page=1&pageSize=10` 即可。
+
+## 核心能力
+
+- 函数即接口：导出 `GET`/`POST` 等函数即声明路由
+- AST 类型校验：TypeScript Compiler API 自动生成运行时校验
+- 洋葱模型中间件：`(ctx, next) => {}`
+- 依赖注入：注入器按参数名匹配 handler 参数
+- WebSocket 路由：导出 `WS` 函数声明
+- SSE 流式响应：`ctx.sse()` 推送
+- 动态路由：`[id]` / `[...slug]` / `(group)`
+- MCP 集成：LLM 可查询路由 schema
+- 配置文件：`faapi.config.ts` 统一响应格式、全局错误处理、生命周期钩子、全局中间件/注入器
+- ESM only
+
+## 文档
+
+完整文档见 [GitHub 仓库](https://github.com/faapi/faapi#readme)。
+
+- [架构与约定](https://github.com/faapi/faapi/blob/main/AGENTS.md)
+- [中间件系统](https://github.com/faapi/faapi/blob/main/packages/faapi/src/middleware/README.md)
+- [路由系统](https://github.com/faapi/faapi/blob/main/packages/faapi/src/router/README.md)
+- [运行时](https://github.com/faapi/faapi/blob/main/packages/faapi/src/runtime/README.md)
+- [配置](https://github.com/faapi/faapi/blob/main/packages/faapi/src/config/README.md)
+- [CLI](https://github.com/faapi/faapi/blob/main/packages/faapi/src/cli/README.md)
+
+## 许可证
+
+[MIT](https://github.com/faapi/faapi/blob/main/LICENSE)