SuperAPI AI 工具集

api-designer

编程与开发

查看项目

更新于 10-16 00:21

技能介绍

用途:api-designer 技能为设计健壮的 RESTful API 和函数契约提供指导,帮助架构设计类智能体产出结构清晰、可维护、符合行业实践的接口设计。它强调 REST 原则、清晰契约、一致的错误处理、认证授权与完整文档。

主要能力:1)REST 端点设计,包括资源命名、HTTP 方法选择、URL 与路径/查询参数、状态码与幂等性;2)请求/响应模式设计,覆盖创建、全量更新、部分更新、列表分页与错误响应;3)统一错误响应格式,含错误类型、字段级校验错误、请求 ID 与时间戳;4)认证与授权,涵盖 JWT、OAuth2、API Key 以及 RBAC/ABAC 权限模型;5)限流设计,含限流头、分层配额与 429 响应;6)API 版本化,支持 URL 路径、请求头、查询参数三种策略及弃用通知。

使用方式:该技能在智能体描述“设计 API 端点”“创建 REST API”“定义函数契约”“指定请求/响应模式”“设计认证”“规划 API 结构”“定义错误响应”“创建 API 文档”等意图时自动激活。使用流程为:识别资源、设计端点、定义模式、规划认证、处理错误、设置限流、编写文档、制定版本化策略。资料中给出的示例使用 Python 的 pydantic 定义模型,并列出端点与状态码。

适用场景:需要为任务管理、用户管理等系统规划 REST API 或函数接口契约时,可用于生成端点清单、数据模式、错误格式与安全策略。

限制:资料未提供具体安装命令、收费方式、平台支持或实际运行效果;示例代码为设计参考,未说明可直接运行。部分内容(如 GraphQL 模式)仅在资源文件中提及,正文未展开。