API 模式:在 REST、GraphQL 与 tRPC 之间做可复用的设计决策

前言

接口选型往往卡在「REST 够不够」「要不要 GraphQL」「全栈 TypeScript 是否上 tRPC」这类问题上。文档里各讲各的优点,落地时却缺少一套能在对话里反复调用的决策框架。下面介绍 SkillHub 上的 API 模式(@org-02qudk26/api-patterns):把 REST / GraphQL / tRPC 相关的设计决策整理成 Agent Skill,让编码助手在方案讨论、评审和起草接口约定时有一致参照。

这是什么

API 模式 是智雨科技在 SkillHub 发布的企业来源 Skill(enterprise),当前版本 1.0.0,分类为 dev-programming。官方简介为:REST / GraphQL / tRPC 的 API 设计决策模式。它不替代具体框架文档,而是把三类 API 风格下的常见设计取舍沉淀为 Skill 指令,供支持 SKILL.md 的 Agent 在安装后按场景调用。页面标注 requires_api_key=false,安装与使用不依赖额外 API Key。

SkillHub 展示页:https://www.skillhub.cn/skills/org-02qudk26/api-patterns
技能元数据地址:https://api.skillhub.cn/org-02qudk26/api-patterns(浏览器直接访问可能返回 405,以商店页与安装文档为准。)

核心功能

依据已公开资料,可核实的能力边界如下:

  1. 多范式覆盖:Skill 主题明确包含 REST、GraphQL、tRPC 三类 API 的设计决策模式,适合在选型或混合架构时对照,而不是只偏向某一种风格。
  2. 决策导向:定位为「设计决策模式」,面向「选哪种暴露方式、资源如何建模、边界如何划分」等问题,而非单点代码生成模板。
  3. Agent 可加载:遵循通用 SKILL.md 生态,安装到对应 Agent 的 skills 目录后,由助手在相关任务中读取 Skill 内容并遵循其中的模式与约束。

未在公开页面列出更细的章节目录或示例清单时,不宜臆测具体模式条数或命名;以安装后本地 SKILL.md 为准。

安装与启用

安装流程以 SkillHub 官方文档为准:https://skillhub.cn/install/skillhub.md。

1、确认 SkillHub CLI

先检查本机是否已有 skillhub:

command -v skillhub && skillhub --version

若未安装,可按文档执行完整安装(CLI + 默认 Skill):

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash

仅需 CLI 时:

curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash -s -- --cli-only

2、安装到当前 Agent 的 skills 目录

文档要求安装时必须用 --dir 指向当前 Agent 识别的 skills 目录,否则默认落在 ./skills/ 可能不会被加载。

坐标为 @org-02qudk26/api-patterns。在 Cursor 中,常用路径为 ~/.cursor/skills/:

skillhub install org-02qudk26/api-patterns --dir ~/.cursor/skills/

其他客户端路径(摘自同一安装文档,按实际环境选用):

  • Claude Code:~/.claude/skills/
  • Codex:~/.codex/skills/ 或项目下的 .agents/skills/
  • Gemini CLI:~/.gemini/skills/

安装完成后,按各客户端说明重启或刷新 Agent,使新 Skill 生效。

3、用自然语言交给 AI 安装(可选)

SkillHub 技能页提供的提示词为:让 AI 根据 https://skillhub.cn/install/skillhub.md 安装 @org-02qudk26/api-patterns。适合尚未配置 CLI、但希望助手代为完成安装步骤的场景。

典型用法

公开资料未附带完整对话样例,可复现的用法如下。

通过 CLI 安装并启用后,在接口设计相关任务中明确引用 Skill,例如:

  • 「我们要对外提供用户与订单数据,客户端有 Web 和移动端,请按已安装的 API 模式 Skill,比较 REST 与 GraphQL 的取舍并给出推荐。」
  • 「现有服务是 Node + TypeScript 单体,计划前后端共享类型,请按 API 模式 Skill 评估是否引入 tRPC,并列出边界条件。」

仅安装、未指定 --dir 时,Skill 可能不在 Agent 搜索路径内;若助手未体现 Skill 内容,先核对安装目录是否与当前客户端一致。

适用场景与注意

适合谁

  • 需要在 REST、GraphQL、tRPC 之间做架构或接口层选型的小团队或独立开发者。
  • 希望把 API 设计讨论固化到 Agent 工作流,减少每次从零查资料、口径不一致的情况。
  • 使用 Cursor、Claude Code、Codex 等支持项目级或用户级 skills 目录的工具链。

限制与注意

  • 评分与下载量以 SkillHub 页面实时展示为准(抓取时页面为评分 100000、下载 1321;线索中的数字若不一致,以商店页为准)。
  • 来源为 enterprise,企业场景下的更新与许可以 SkillHub 与发布者说明为准。
  • 本 Skill 提供的是决策模式与约束,不能替代安全评审、性能压测与 OpenAPI / Schema 等具体交付物;上线前仍需按团队规范做审查。
  • api.skillhub.cn 上的元数据 URL 不适合作为人工浏览入口;安装与检索以 skillhub CLI 与 https://www.skillhub.cn/skills/org-02qudk26/api-patterns 为主。

结尾

API 模式 把 REST、GraphQL、tRPC 的设计决策收敛为可安装的 Agent Skill,适合在编码助手会话里统一接口选型与设计口径。安装坐标:@org-02qudk26/api-patterns,版本 1.0.0,官方介绍页:https://www.skillhub.cn/skills/org-02qudk26/api-patterns。

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜