nodejs-backend-patterns 是做什么的?
使用 Express/Fastify 构建生产就绪的 Node.js 后端服务,实现中间件模式、错误处理、身份认证、数据库集成和 API 设计最佳实践。适用于创建 Node.js 服务器、REST API、GraphQL 后端或微服务架构。
概述
该技能为 Node.js 后端开发提供了一套完整且行业认可的模式和最佳实践集合。无论您是在构建一个新的 REST API 还是扩展一个现有的 GraphQL 服务,本技能都能确保您的代码遵循可靠的设计原则,并且已经为生产环境做好准备。
核心功能
- 服务器框架支持:无缝集成 Express 和 Fastify,提供一致的开发体验。
- 中间件模式:实现日志记录、请求验证、安全头设置等自定义中间件。
- 错误处理:建立统一的错误处理机制,包括异步错误捕获和用户友好的错误响应。
- 身份认证:支持 JWT、OAuth2 等常见认证方案,并提供会话管理和权限控制。
- 数据库集成:连接 PostgreSQL、MySQL、MongoDB 等数据库,使用 ORM(如 Prisma、TypeORM)或原生驱动。
- API 设计:遵循 RESTful 和 GraphQL 最佳实践,包括版本控制、资源命名、分页、过滤和排序。
- 环境配置:通过环境变量管理配置,支持不同环境(开发、测试、生产)。
使用方法
在支持该技能的 AI 编码助手(如 Claude Code、Cursor、Codex)中,直接引用 wshobson/nodejs-backend-patterns 即可激活。您可以提出以下类型的请求:
- “创建一个基于 Express 的后端服务,包含基本的中间件和错误处理”
- “设计一个带有 JWT 认证的 REST API”
- “帮我设置一个 Fastify 服务,并集成 MongoDB 数据库”
- “实现一个 GraphQL 后端,包含用户和文章模型”
示例
// 使用 Express 创建一个简单的 API 服务器
const express = require('express');
const app = express();
// 全局中间件
app.use(express.json());
app.use(require('./middleware/logger'));
// 路由
app.get('/api/users', (req, res) => {
res.json({ users: [] });
});
// 错误处理
app.use((err, req, res, next) => {
console.error(err.stack);
res.status(500).json({ error: 'Internal Server Error' });
});
app.listen(3000, () => console.log('Server running on port 3000'));
最佳实践
- 始终使用环境变量存储敏感信息(如数据库密码、API 密钥)。
- 对输入数据进行严格的验证和清理。
- 使用异步错误包装器防止未捕获的 Promise 拒绝。
- 实施速率限制和 CORS 策略。
- 编写单元测试和集成测试。
- 使用日志系统(如 Winston 或 Pino)记录关键事件。
支持的平台
- Claude Code
- Cursor
- Codex
- 其他兼容的 AI 编码助手
许可证
MIT