Api Generator

⚡ 秒级生成生产级 API 脚手架

一站式 API 代码生成工具,支持 REST/GraphQL/Swagger 文档、客户端 SDK、Mock 服务、认证与限流代码及测试套件,快速搭建生产级后端脚手架。

收藏
12.3k
安装
3.3k
版本
2.3.4
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

API Generator 是一款面向后端开发者的代码脚手架生成工具,通过简洁的命令行交互,可在数秒内输出可直接运行的 API 代码模板。其核心工作流围绕 bash scripts/apigen.sh <command> <resource> 展开,覆盖从协议层到安全层的完整技术栈。

生成能力矩阵:

| 命令 | 输出内容 | 技术栈 |
|:---|:---|:---|
| `rest` | CRUD 端点 + 路由 + 控制器 | Express.js |
| `graphql` | Schema + Resolver + Type Definition | GraphQL |
| `swagger` | OpenAPI 3.0 YAML/JSON 规范文档 | OpenAPI Specification |
| `client` | 类型安全的 API 调用类 | Python |
| `mock` | 带内存存储的模拟服务器 | Node.js/Express |
| `auth` | 认证中间件/工具函数 | JWT / OAuth2 / API Key |
| `rate-limit` | 限流中间件 | Token Bucket / Sliding Window |
| `test` | 集成测试套件 | Jest + Supertest |

所有代码默认输出至 stdout,支持管道重定向或直接复制到项目目录。生成的代码包含完整注释,可作为生产代码的起点或教学参考。

显著优点

1. 全栈覆盖:单一工具贯穿协议定义、安全实现、测试验证,避免多工具切换的认知负担
2. 零配置启动:无需初始化项目或安装依赖,直接生成可用代码片段

3. 教育友好:输出代码包含详尽注释,适合团队新人理解 REST/GraphQL 最佳实践

4. 输出透明:stdout 输出机制便于 CI/CD 管道集成,可程序化地注入生成流程

潜在局限

  • 技术栈锁定:当前仅支持 Express.js(REST/Mock)、Python(Client),未覆盖 Go/Rust/Django 等生态
  • 模板僵化:生成代码基于固定模板,复杂业务场景仍需手动重构
  • 无持久化层:Mock 服务仅提供内存存储,无数据库集成选项
  • 版本管理缺失:未内置模板版本切换或自定义模板覆写机制

适合人群

  • 快速原型开发(MVP 阶段需要可运行的后端接口)
  • 前端开发者需要临时 Mock 服务并行开发
  • 技术面试官快速搭建标准化代码考卷
  • 微服务团队需要统一各服务的 OpenAPI 文档规范

常规风险

  • 代码审计依赖:生成代码虽含注释,但安全实现(如 JWT secret 生成、OAuth scope 校验)需人工复核
  • 生产直接使用风险:模板代码未经过负载测试,高并发场景需补充性能优化
  • 依赖版本漂移:生成的 package.jsonrequirements.txt 可能引用过时依赖,建议定期扫描

Api Generator 内容

scripts文件夹
手动下载zip · 10.3 kB
apigen.shtext/x-shellscript
请选择文件