SuperAPI AI 工具集

api-designer

编程与开发

查看项目

更新于 10-16 06:22

技能介绍

用途:api-designer 是一个 REST API 架构设计技能,根据用户描述的系统或领域生成完整、可产出的 API 端点规范。

主要能力:生成端点清单;按资源分组展开详细设计;遵循 RESTful 约定(集合用复数名词、关系用嵌套路径如 /hotels/{id}/rooms);默认使用 Bearer token(JWT)鉴权,第三方集成可用 X-Api-Key,公开端点明确标注无鉴权;请求体给出真实 JSON 字段、类型与说明,并标注必填与可选;响应给出成功响应结构及 HTTP 状态码;每个端点列出相关错误码;列表端点包含 page、limit、sort、filter 等查询参数,并采用统一分页封装(data、pagination:total、page、limit、totalPages);路径默认加 /api/v1/ 前缀,除非用户另行指定。

使用方式:先询问用户需要“仅端点”还是“详细设计”,若用户已在输入中说明则不再询问;按技能规定的结构输出,先依次列出所有端点,再按资源分组展开;若用户只指定某些内容(如 Headers、Status Codes),则仅输出这些。技能会读取 references/domains.md 获取各领域预置资源清单,读取 references/testmu_example.md 获取结构示例。设计完成后询问是否生成 API 文档:若已安装 API Documentation 技能则按该技能说明以其输出为输入生成纯文本文档;未安装则提示可安装后重试或直接生成基础文档。

适用场景:需要为任意系统或领域设计 REST API 的端点、请求响应结构与鉴权方案时。

限制:资料未提供该技能的具体安装命令、收费与价格信息,也未说明其支持的平台或运行环境;输出以英文资料描述为准,实际生成效果暂未提供更多验证信息。