Skip to content

Damba

一个 AI 友好、基于模式驱动的 Express 框架。声明您的 TypeORM 实体和一个 服务映射;Damba 将围绕它们连接 REST 路由、验证、身份验证、文档、BullMQ 队列 和 Socket.io。它扁平、易于 grep 的约定(没有 DSL 魔法)让每个服务都便于人类 以及 AI 编码智能体阅读、生成和审查。

模式 / 实体  →  服务  →  路由  →  文档

您获得什么

  • AI 友好的设计 —— 可预测的 模式 → 服务 → 路由 → 文档 结构,以及扁平、易于 grep 的约定(没有 DSL 魔法),让 LLM 和编码智能体能够可靠地生成与审查。
  • 自动生成的 CRUD —— 来自任何 TypeORM 实体,带有可选的 before / after 钩子。
  • 类型化行为 —— 工厂函数,具有一流的请求上下文。
  • 策略 —— 可组合的授权步骤,具有稳定的 JSON 错误形状。
  • 实时 —— Socket.io 包装在与您的 HTTP 路由相同的租户 + 关联上下文中。
  • 队列 —— BullMQ 生产者 + 监听器共享请求 ALS 上下文。
  • 错误 —— 中央 DambaError 层次结构生成标准化的 JSON 响应。
  • 文档 —— 自动生成的 API + Extras 页面。

快速开始

bash
npm install damba-v2

请参阅快速开始(英文)获取完整的端到端示例,或使用 启动模板

中文翻译状态

此部分正在翻译中。目前,完整文档仅以英文提供。

想要贡献翻译? 在 GitHub 上打开 PR

链接

Released under the MIT License.