SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 01:27

技能介绍

用途:覆盖 OpenAPI 规范全生命周期,包括从零设计规范、评估现有规范、以及修复发现的问题。

主要能力:

  • 设计:通过对话式引导从零生成 OpenAPI 3.x YAML,依据 WSO2 REST API 设计指南,产出面向 AI 智能体使用的规范。
  • 评估:支持三个维度——AI 智能体就绪性(Spectral 规则加 AI 分析)、安全性(源自 OWASP 的 API 安全检查)、API 设计指南(WSO2 REST 设计规则,28 项检查)。
  • 修复:按修复工作流在用户确认后编辑规范文件。

使用方式:

  • 评估前须确认已安装 Spectral,运行 spectral --version;若未安装,用 npm install -g @stoplight/spectral-cli 安装后重试。
  • 评估报告写入 ./api-reports/。修复前须获得用户确认。
  • 设计流程分步:理解领域、理解数据模型、派生并确认资源、产出大纲、迭代细化、生成 OpenAPI YAML、提供评估。生成的分页响应采用 { count, next, previous, data: [...] } 信封结构;集合 GET 使用 limit(默认 20)与 offset(默认 0)。

适用场景:需要设计新 API、审查现有规范质量,以及检查 API 对 AI 智能体的友好性与安全性时。

限制:需本机存在规范文件路径;依赖 Spectral CLI;评估结果与报告路径等细节以工具实际行为为准,现有资料未提供价格、平台支持范围等其它信息。