SuperAPI AI 工具集

api-design-principles

编程与开发

查看项目

更新于 10-16 01:12

技能介绍

用途:该技能聚焦 REST 与 GraphQL API 的设计原则,目标是构建直观、可扩展、可维护且对开发者友好的 API。

适用场景:设计新的 REST 或 GraphQL API;重构现有 API 以提升可用性;为团队建立 API 设计标准;在实现前评审 API 规范;在 API 范式之间迁移(如 REST 转 GraphQL);编写开发者友好的 API 文档;针对移动端、第三方集成等特定用例优化 API。

不适用场景:仅需要某个具体框架的实现指导;只做基础设施工作且不涉及 API 契约;无法更改或对公共接口进行版本管理。

使用方式(指令步骤):1. 明确消费者、用例与约束;2. 选择 API 风格并建模资源或类型;3. 规定错误、版本管理、分页与认证策略;4. 用示例验证并检查一致性。详细模式、检查清单与模板参见 resources/implementation-playbook.md。

限制:资料未提供具体框架实现细节、代码示例、收费或平台信息;实际落地需结合项目约束与团队规范。