SuperAPI AI 工具集

api-workshop

编程与开发

查看项目

更新于 10-16 05:46

技能介绍

用途:API Workshop 用于设计新 API 或评审已有 API,通过多智能体辩论产出经过论证的 API 规范。若用户提供现有规范 URL,则转为评审而非从零设计。

主要能力:五个专职智能体参与——API Designer(消费体验、可发现性、命名)、Domain Modeler(建模正确性、一致性、DDD)、Security Auditor(认证授权、数据暴露、OWASP)、Performance Analyst(效率、缓存、过度/不足获取)、Tech Lead(标准合规、版本化、文档)。工作流分五阶段:上下文收集、并行初始提案、交叉质询(围绕 API 风格、认证策略、版本化、资源设计、错误处理等展开小型辩论)、综合决策、生成最终交付物。输出包含执行摘要、架构、完整规范、设计理由、权衡取舍、实现说明与多语言客户端示例,保存至 workspace/api-specification.md。

使用方式:需先准备 REFERENCE.md(含 OpenAPI 模板、设计原则与辩论提示)。用户提供 API 描述(必填)或现有规范 URL,可选提供业务上下文、关注领域、格式偏好(OpenAPI 3.x、GraphQL schema、AsyncAPI)。示例调用:/api-workshop design an API for a task management system;/api-workshop review https://api.example.com/openapi.json;/api-workshop design a GraphQL API for e-commerce with subscriptions;/api-workshop compare REST vs GraphQL for our social network。可定制:跳过智能体、添加约束、指定风格、设定优先级、提供示例、要求特定辩论。

适用场景:新 API 设计、现有 API 评审、REST 与 GraphQL 等方案对比。

限制:资料未提供具体安装命令、收费方式、平台支持与效果数据;需依赖 REFERENCE.md 与 agents/*.md 等文件;输出目录结构固定为 workspace/ 下的上下文、提案、辩论与最终规范文件。