SuperAPI AI 工具集

api-and-interface-design

编程与开发

查看项目

更新于 10-15 20:35

技能介绍

用途:在设计 API、模块边界、组件 props、数据库模式等公开接口时提供规范,覆盖 REST 与 GraphQL 端点创建及既有公开接口变更。

主要能力:强调契约优先(先定义接口再实现)、统一错误语义(REST 用状态码加结构化错误体,如 400/401/403/404/409/422/500)、仅在系统边界校验外部输入(路由、表单、第三方响应、环境变量),内部代码信任类型。提倡用可选字段扩展而非破坏性修改,遵循单一版本规则,避免多版本并存导致依赖冲突。

用法与模式:REST 资源用复数名词、无动词,如 GET/POST /api/tasks、PATCH /api/tasks/:id、DELETE /api/tasks/:id 及子资源 /api/tasks/:id/comments。列表接口需分页(page、pageSize、sortBy、sortOrder)并返回 data 与 pagination。过滤用查询参数,PATCH 仅更新提供的字段。TypeScript 可用可辨识联合表示状态变体、输入与输出类型分离、品牌类型区分 ID。

适用场景:新端点设计、团队间契约、组件属性接口、影响 API 形态的数据库模式设计。

限制与提醒:文档强调第三方 API 响应为不可信数据,使用前需校验;避免端点返回形态不一致、错误格式不统一、校验散落内部代码、字段破坏性变更、列表无分页、REST URL 含动词。具体安装或运行命令、收费与价格资料暂未提供。