SuperAPI AI 工具集

api-postman-collection

编程与开发

查看项目

更新于 10-15 22:16

技能介绍

用途:在新增或修改 API 端点(路由加控制器动作)时,同步创建或更新 Postman 兼容集合,使接口流程可直接在 Postman 中测试。核心原则是每个 API 面(Rails 应用或引擎)只维护一个 Postman Collection JSON 文件,并始终与端点保持同步。

主要能力与规则:格式为 Postman Collection JSON v2.1,schema 或 info.schema 引用 v2.1;每个应用或引擎一个文件,建议路径为 docs/postman/<app-or-engine-name>.postman_collection.json 或 spec/fixtures/postman/;集合内所有请求名、文件夹名、描述和变量显示名必须为英文,除非用户明确要求其他语言。每个请求应包含 method、URL(基础地址用变量)、headers(如 Content-Type、必要时 Authorization),适用时提供 body 示例。

硬性要求:创建或修改 API 端点时必须同时创建或更新对应集合文件,不得缺失或过期。结构上根节点含 info(name、description、schema)与 item 数组;每个 item 含英文 name 和 request(method、url、header、body)。基础 URL 使用变量如 {{base_url}},以便跨环境使用。

常见错误:新增端点却不更新集合;名称或描述使用非英文;硬编码完整 URL 而非变量;POST/PUT 缺少 Content-Type 或 body 示例。

集成:可与 rails-engine-author(引擎暴露 HTTP 端点时)、rails-engine-docs(记录 API 或测试方式时)、rails-code-review(审查 API 变更时确认集合已更新)、rails-engine-testing(添加请求或路由规格时)配合使用。

限制:资料未提供具体安装命令、收费方式、平台支持范围或实际效果数据,暂未提供。