SuperAPI AI 工具集

endpoint-design

编程与开发

查看项目

更新于 10-16 09:30

技能介绍

用途:在资源建模之后设计具体 API 端点,产出端点清单,决定 HTTP 方法与状态码,统一命名规范。参考 RFC 7231 HTTP/1.1 Semantics 与 GitHub REST API Guidelines。

主要能力:用 HTTP 方法表达动作、用状态码表达结果;提供方法语义表(GET/POST/PUT/PATCH/DELETE/HEAD/OPTIONS 的用途、幂等与安全);列常见 2xx/3xx/4xx/5xx 状态码含义;给出路径(复数、小写、连字符、不带后缀)、查询参数与 Header 命名规范;给出标准 CRUD 端点写法与端点清单表格模板(Method/Path/用途/调用方/权限/成功状态码/失败状态码/幂等/Mock)。

使用方式:读取资源清单,对每个资源套用标准 CRUD,识别特殊端点(动作或查询变体),决定方法,列出可能状态码,标注权限与幂等,输出端点清单,再转交 request-response 设计字段。

适用场景:资源建模后的端点列表、单端点 method+path 设计、HTTP 状态码选择、端点命名规范。

限制:资料未提供具体安装命令、收费或平台信息;内容为设计规范与模板,未提供代码实现示例。协作上游为 resource-modeling,下游可对接 openapi-mock,平行有 request-response、error-handling、auth-permission。