文档CLAUDE.md 模板Node.js + Express API

Node.js + Express API

适用于需要快速搭建 REST API 的团队项目,重点是可维护的目录结构、统一错误处理与可观测性。

适用场景

  • 中小型业务 API 服务
  • 需要 JWT / RBAC 的后端系统
  • 需要 CI 中自动执行测试与安全扫描

推荐 CLAUDE.md 片段

## Tech Stack
- Runtime: Node.js 20+
- Framework: Express 5
- Validation: Zod
- ORM: Prisma
- Test: Vitest + Supertest
 
## API Conventions
- 所有错误返回统一格式:{ code, message, requestId }
- 变更接口必须补充集成测试
- 关键路径加入结构化日志

开发建议

  1. 先定义 API 契约(请求/响应)再写控制器。
  2. 把业务逻辑放在 service 层,路由层保持薄。
  3. 在 PR 流程中加入 lint + test + typecheck

相关页面

关于我