SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-15 16:43

技能介绍

用途:面向 REST 与 GraphQL API 的契约设计与评审,适用于新建 CRUD 风格 REST 契约、为多客户端设计 GraphQL schema、对现有 API 做一致性评审、决定 REST 与 GraphQL 的取舍或混用边界,以及统一鉴权、限流、可观测性、幂等与长任务等横切关注点。

主要能力:提供端到端工作流(需求→风格选择→领域建模→操作设计→横切关注点→交付物);REST 侧覆盖面向资源的建模、稳定标识符、关系模式与 HTTP 动词用法;GraphQL 侧覆盖 schema/类型建模、Query 与 Mutation 分离、写入用 input 类型与副作用说明;并提供统一错误模型、分页/过滤/排序、版本化与弃用策略、评审清单与可执行跟进项。

使用方式:先澄清消费者(Web/移动/内部)、约束(延迟、一致性、合规、数据敏感度)与核心用例;再选择风格与边界;随后按参考文档 references/rest.md、references/graphql.md 建模,并用 references/review-checklist.md 校验命名、状态码、分页规则、错误模型稳定性、版本与弃用、安全与可观测性。示例给出基础 URL https://api.example.com/v1,端点如 GET /v1/projects、POST /v1/projects/{projectId}/tasks、PATCH /v1/projects/{projectId}/tasks/{taskId},创建任务支持 Idempotency-Key 请求头,列表用 limit/cursor/sort 分页,错误示例含 code、message、details、requestId。

适用场景:需要统一 API 契约与评审标准、跨服务标准化横切关注点的团队。

限制:该技能为纯文档技能,无依赖,不提供运行时实现或代码生成;具体性能指标、合规要求与交付物细节需由使用者自行确定。价格与平台支持信息暂未提供。