核心功能
API Generator 是一款面向后端开发的命令行代码生成工具,通过统一脚本 apigen.sh 提供 8 大类 API 相关代码的自动化生成能力。
主要用法
执行 bash scripts/apigen.sh <command> <resource_name> [options],支持以下指令:
- rest:生成 Express.js 风格的 RESTful CRUD 端点代码
- graphql:生成 GraphQL 的 Type 定义 + Query/Mutation 模式
- swagger:输出 OpenAPI 3.0 规范的 YAML/JSON 文档
- client:生成 Python API 客户端类代码
- mock:启动带内存存储的 Mock API 服务器
- auth:生成 JWT / OAuth / API Key 认证中间件代码
- rate-limit:实现令牌桶或滑动窗口限流算法代码
- test:输出 Jest + Supertest 的 API 测试套件模板
所有代码直接输出至 stdout,可重定向到项目文件,包含完整注释,适合作为项目起点。
显著优点
- 开箱即用:零配置即可生成生产级代码结构
- 多协议覆盖:REST/GraphQL/Document(OpenAPI) 全栈支持
- 开发闭环:从接口定义 → 服务端 → 客户端 → 测试 → 文档一站式覆盖
- 轻量无依赖:纯 Bash 脚本驱动,不绑定特定框架版本
潜在局限
- 输出代码为模板性质,复杂业务逻辑仍需人工扩展
- 无交互式 CLI 向导,需熟记命令参数
- 仅支持 stdout 输出,无直接文件写入或项目初始化功能
- Mock 服务器为内存存储,重启即丢失数据
适合人群
- 需要快速搭建 API 原型或 MVP 的后端开发者
- 学习 REST/GraphQL 最佳实践的初学者
- 需要统一团队代码生成规范的技术负责人
常规风险
- 生成的认证代码(JWT/OAuth)为示例实现,生产环境需审计加密强度、密钥管理及令牌存储
- 自动生成的测试套件为基础模板,覆盖率与边界场景需补充
- 建议将生成代码纳入版本控制审查流程,避免直接部署未经验证的模板代码