SuperAPI AI 工具集

api-designer

编程与开发

查看项目

更新于 10-15 23:44

技能介绍

用途:设计、审查并文档化一致、直观、可维护的 API,遵循 REST 资源导向约定与 GraphQL 最佳实践。

主要能力:按九步工作流覆盖 API 设计全流程——识别资源与操作、定义 URL 结构、设计请求/响应模式、错误处理、分页、过滤与排序、版本控制、认证、文档。提供 HTTP 方法映射表(GET/POST/PUT/PATCH/DELETE 及动作型 POST)、URL 反模式清单、标准成功与集合响应示例、统一错误格式与状态码用法、错误码注册规范、偏移与游标分页、过滤排序参数格式、URL 路径版本控制、Bearer 令牌与 API Key 认证及限流响应头。

使用方式:当需要设计 API、创建端点、审查 API 一致性或生成 OpenAPI 规范时调用。输出包括资源与端点清单、带示例的请求/响应模式、错误场景与代码、分页与过滤参数,以及 OpenAPI 3.x 规范。

适用场景:REST 或 GraphQL API 的新建设计与既有 API 审查、接口文档编写、团队 API 规范统一。

限制:资料未提供具体安装命令、收费方式、平台支持或实际效果数据;GraphQL 部分仅提及遵循最佳实践,未展开具体规则。