用途
Postman Collection Generator 用于从现有 API 代码库自动生成可导入的 Postman 集合,免去手动在 Postman 中逐个创建请求的工作。它扫描代码中的路由定义,将端点抽取并整理为标准 Postman Collection v2.1 JSON。
主要能力
- 扫描路由:在代码库中查找所有 API 路由定义。
- 提取元数据:识别 HTTP 方法、路径、路径与查询参数、请求体、请求头。
- 端点分组:按资源或文件夹结构组织端点。
- 生成集合:输出 Postman Collection v2.1 JSON。
- 添加示例:包含请求/响应示例。
- 配置变量:提供 baseUrl、authToken 等环境变量模板。
支持的框架
根据资料,支持以下框架及其路由模式:
- Express:app.get()、router.post() 等 app/router 上的方法链。
- Next.js:app/api/**/route.ts 文件式路由。
- Fastify:fastify.get()、route schema,方法与 schema 装饰器。
- Hono:app.get()、app.post(),与 Express 类似。
- NestJS:@Get()、@Post() 等基于装饰器的路由。
- Koa:router.get()、router.post() 等 Koa-router 模式。
生成内容
集合遵循 Postman Collection v2.1 Schema(https://schema.getpostman.com/json/collection/v2.1.0/collection.json),包含 info、item、variable、auth 等结构。
生成器会按资源对路由分组,例如 /api/users/:id 归入 users 文件夹;为路径参数生成变量(如 :id 转为 {{id}});为 POST/PUT/PATCH 生成原始 JSON 请求体;并默认添加 Content-Type: application/json 请求头。集合变量通常包含 baseUrl 与 authToken,认证可配置为 bearer 等类型。
使用方式
资料提供了可为 Express、Next.js、Fastify 分别扫描的脚本示例,以及一个 CLI 脚本。该 CLI 基于 commander 定义选项:
- -f, --framework <type>:框架类型,默认 express
- -s, --source <path>:源码目录,默认 ./src
- -o, --output <path>:输出文件,默认 ./postman-collection.json
- -n, --name <name>:集合名称,默认 API Collection
- -b, --base-url <url>:基础 URL,默认 http://localhost:3000
- -a, --auth <type>:认证类型(bearer|basic|apikey)
运行后根据所选框架扫描路由,生成集合 JSON 并写入输出路径,同时在控制台输出端点数量。资料还给出了环境模板示例,包含 baseUrl、authToken(secret 类型)、userId 等变量。
适用场景
适用于已有 Express、Next.js、Fastify、Hono、NestJS 或 Koa API 代码库,希望快速得到 Postman 集合以便接口调试、分享或纳入版本控制的团队。资料建议在路由变更时自动生成、集成到 CI,并将集合 JSON 提交到代码仓库。
限制
资料未提供该技能的安装命令、运行环境依赖版本、性能与规模上限、错误处理策略等具体信息。上述功能均以资料给出的脚本示例与说明为准,未提及的收费、价格、平台支持情况暂未提供。