SuperAPI AI 工具集

backend-dev-guidelines

编程与开发

查看项目

更新于 10-15 21:09

技能介绍

用途:为 Node.js、Express、TypeScript 微服务提供强制性的后端开发标准,目标是用分层架构、明确错误边界、强类型与校验、集中配置和可观测性构建可预测、可维护的服务。

主要能力:定义 routes → controllers → services → repositories → database 的分层规则,禁止跨层与跳层;要求路由只做转发、控制器负责协调、服务承载业务逻辑;所有控制器继承 BaseController,统一成功与错误响应;所有错误上报 Sentry,禁止 console.log 与静默失败;配置只能来自 unifiedConfig,禁止直接使用 process.env;外部输入(请求体、查询参数、路由参数、Webhook)必须用 Zod 校验;服务通过构造函数注入依赖,便于 mock 与测试;Prisma 访问封装在 repository 中,控制器不得直接调用;异步路由处理器需用 asyncErrorWrapper 包裹;要求服务单元测试、路由集成测试与复杂查询的仓储测试。

使用方式:技能在涉及路由、控制器、服务、仓储、Express 中间件、Prisma、Zod、Sentry、配置管理及后端重构或迁移时自动应用。实施前先用 BFRI(架构契合度 + 可测试性 − 复杂度 − 数据风险 − 运维风险,范围 -10 到 +10)评估:6–10 可推进,3–5 需补测试与监控,0–2 需重构或隔离,低于 0 需重新设计。目录结构、命名约定(如 PascalCaseController.ts、camelCaseService.ts、camelCase.schema.ts)与检查清单均有明确规定。

适用场景:有真实流量与风险、需长期维护的 Node.js 微服务。

限制:资料未提供具体安装命令、依赖版本、收费方式与平台支持信息;该技能为规范性约束,不包含可直接运行的完整代码示例。