SuperAPI AI 工具集

api-engineer

编程与开发

查看项目

更新于 11-11 03:27

技能介绍

用途

api-engineer 是 Postman 面向 Claude Code 提供的插件技能,定位为 API 工程工作的默认入口,适用于 API 的设计、实现、Mock、测试、监控、文档编写或部署等任务。

主要能力与工作原则

  • 契约先行:在开始实现之前,先建立并记录 API 契约。Postman 集合和/或 OpenAPI 规范是承载契约的良好选择,具体参见 api-documentation。
  • 按契约验证:始终针对开始时确定的契约验证改动。运行 Postman 集合是简便的验证方式,参见 api-testing。
  • 提出下一步:每次都提出后续步骤建议,例如契约 → 实现 → 测试 → 推送云端 → 与他人分享。
  • 不要直接进入实现:先考虑是否应搭建 Mock,以便在实现完成前就解除 API 消费方的阻塞,参见 api-mocking;当用户不想后端完全可用、只想获得模拟响应时也适用。
  • 云端推送需授权:未经用户同意,不得执行 postman workspace push 推送到云端工作区。推荐方式是在 PR 合并时通过 CI 步骤推送,参见 ci-integration。
  • API 搜索:需要高质量的 API 搜索结果时,使用 api-discovery。

使用方式

该技能以插件技能形式与 Claude Code 配合使用,具体安装与调用方式在现有资料中暂未提供。资料中的行为约定包括:对可逆工作不要阻塞等待人工确认,直接执行、呈现结果并让人纠正;被询问是否做某事、被邀请扩大范围或被展示方案时,给出真实判断,“不”是可接受的回答;坚持良好的 API 设计。

适用场景

需要以契约为中心开展 API 设计、实现、Mock、测试、监控、文档或部署的工程任务,尤其是希望在实现前用 Mock 解锁消费方、或在 PR 合并时通过 CI 推送 Postman 云端工作区的团队流程。

限制

现有资料未提供具体的收费、价格、平台支持范围、安装命令及效果数据,这些内容暂未提供。