SuperAPI AI 工具集

API Contract Sync Manager

编程与开发

查看项目

更新于 10-15 16:49

技能介绍

用途:让 API 规范文件与后端代码实现保持同步,发现破坏性变更并生成类型安全的客户端代码。

主要能力:

  1. 规范校验:检查 OpenAPI/Swagger 的语法结构、$ref 引用、必填字段、安全定义与参数约束;校验 GraphQL SDL、解析器覆盖与循环依赖。
  2. 实现匹配:从规范提取端点,再到代码中查找路由定义(Express、FastAPI、Django、Spring Boot 等),标记已匹配、漂移、缺失或未文档化的端点。
  3. 破坏性变更检测:对比两个规范版本,区分破坏性变更(删除端点、改参数类型、可选变必填、改状态码等)与非破坏性变更,并生成迁移指南。
  4. 客户端代码生成:由规范生成 TypeScript 接口、HTTP 客户端函数,可选生成 React Query 钩子,并附 JSDoc 注释。
  5. 覆盖率分析:计算文档与实现的覆盖率,列出差集与签名不一致处。

使用方式:以技能形式在对话中触发,如“校验 OpenAPI 规范”“实现与规范是否一致”“对比 v1 与 v2 规范”“由规范生成 TypeScript 类型”“哪些端点缺少文档”。可用工具时命令示例:npx @stoplight/spectral-cli lint openapi.yaml、npx graphql-inspector validate schema.graphql、npx openapi-diff old.yaml new.yaml、npx graphql-inspector diff old.graphql new.graphql。基础校验与对比无需额外依赖,高级功能可能提示通过 npm 安装工具。

适用场景:处理 .yaml/.json 规范文件或 .graphql/.gql 架构,审查 PR 中的 API 变更,生成类型与客户端,制定版本策略,帮助新成员理解 API 代码库。

限制:资料未提供具体安装方式、运行环境要求、收费与价格信息;推荐工具需另行安装。