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。

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

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

小夜