用 Claude Code 做前後端契約聯調:OpenAPI 先行、子代理隔離與防改亂公共類型

讓 AI 同時改前後端接口總是出現字段駝峰不統一、漏判空導致頁面白屏?本文按 Claude Code 規劃模式與權限隔離機制,拆解 OpenAPI 契約先行、鎖定自動生成類型目錄及前後端並行聯調的三套可直接複製提示詞。

NNathaniel bigo··原創首發·AI 輔助撰寫
9 分鐘讀完
資料核對於 2026-11-19 · 依據官方文檔與公開資料整理 Pro 帳號

結論先說

  1. 治好前後端字段打架的唯一根治法是「契約文件先行,嚴禁口頭傳話」:寫任何業務代碼前,先開 Plan Mode(規劃模式) 把 openapi.yaml(或共享 Zod Schema)定死,把它當成前後端子代理共同遵守的唯一法律。
  2. 用 settings.json 的 deny 規則把自動生成的類型目錄焊死:前端的接口類型只准由腳本(如 openapi-typescript)從契約文件單向導出,禁止智能體手改生成物欺騙編譯器。
  3. 契約敲定後,派前後端兩個獨立子代理(或雙工作樹)並行落地:各自只看契約和本端源碼,互不污染上下文窗口。
  4. 全棧多代理聯調對週期會話消耗較高:按開發強度可在本站選擇 Claude Pro 充值說明 或重度開發首選的 Claude Max 充值頁。

口頭改接口與契約先行工作流對比

圖:本站結合 Claude Code 官方工作流文檔 整理的協作模式對比圖

本文根據 Anthropic Claude Code 官方文檔《Common workflows》《Subagents》《Permissions》(code.claude.com/docs)整理,資料核對於 2026-11-19。配圖為本站整理的示意圖,不是軟件截圖。本站(bigolab.com)不是 Anthropic 官方網站。

適用於誰

  • 一個人用 Claude Code 全棧包辦前後端,經常遇到「後端返回 created_at,前端組件裏卻寫成 createdAt」反覆返工的獨立開發者;
  • 團隊前後端分離在兩個目錄或兩個倉庫,想靠一份 openapi.yaml 讓兩邊智能體一次對齊零扯皮的技術負責人;
  • 頭疼智能體為了偷懶消掉 TypeScript 紅線,直接跑去手改自動生成的 api-types.d.ts 掩耳盜鈴的程式員。

一、搭好防改亂護欄:鎖定生成目錄 + 四步閉環

OpenAPI 契約先行前後端聯調四步

圖:本站根據 Claude Code 權限與子代理機制 整理的四步聯調流程示意圖

在開始發提示詞之前,先在項目根目錄 .claude/settings.json 加一條硬拒絕規則,徹底堵死智能體「改不動業務代碼就去把類型文件改成 any」的壞毛病(權限語法詳見 Claude Code 安全與 deny 拒絕規則配置):

json
{
  "permissions": {
    "deny": [
      "Edit(frontend/src/generated/**)",
      "Write(frontend/src/generated/**)"
    ]
  }
}

如果前後端拆在兩個相鄰倉庫,啟動時用 --add-dir ../backend 把兩邊掛進同一視野(前端與後端單端搭建基礎見 用 Claude Code 搭前端項目 與 後端 API 與數據庫開發)。

Claude Code 免上號訂閱與高配額省心方案:在大倉庫跑百萬上下文、多子包重構或複雜慢查詢排障時,固定月費訂閱比純按量 API 更容易鎖死成本上限。本站支持支付寶、微信支付與 AlipayHK 卡密自助兌換 iOS 鏈路的 Claude Pro 自助充值、5 倍額度的 Claude Max 5x 與頂配 Claude Max 20x,無需交出帳號密碼。

二、三段可直接複製的契約聯調提示詞模板

1. 階段一:切規劃模式起草並評審 OpenAPI 契約

先按兩次 Shift+Tab 切進只讀 Plan Mode(詳見 Claude Code Plan Mode 規劃模式教學),發送:

text
我需要新增「批量導出發票申請與異步下載狀態查詢」兩組接口。
請先閱讀現有的 contracts/openapi.yaml 了解我們團隊的分頁包裝格式與統一錯誤碼結構,起草本次新增路由的完整 OpenAPI 3.1 Schema 變更草案(含請求校驗約束、可空字段 nullable 顯式標註及 400/403/409 狀態碼響應體),先不要修改任何前後端業務源碼。

2. 階段二:生成類型並分派前後端子代理並行實現

人工看一眼契約草案確認字段命名與可空性滿意後,切回正常模式發送(自定義子代理寫法見 Claude Code 自定義子代理實例):

text
契約已確認。請按以下順序推進:
1. 將上述定義寫入 contracts/openapi.yaml,並運行 npm run gen:api-types 更新前端只讀類型文件;
2. 派一個後端子代理在 backend/src/invoices 下嚴格對照新契約實現路由、入參校驗與集成測試;
3. 派一個前端子代理在 frontend/src/features/invoices 下基於生成的強類型接口完成列表輪詢、空狀態與報錯提示,嚴禁使用 as any 強轉類型。

3. 階段三:契約一致性收尾核驗

text
請運行後端集成測試捕獲真實接口返回的 JSON 載荷樣本,逐字段比對 contracts/openapi.yaml 的定義(特別檢查日期字符串格式、空數組與 null 是否完全一致),並確認 frontend 下運行 tsc --noEmit 零類型錯誤。

人工必查清單:合併代碼前,請親自抽查三點——分頁總數 total 在空列表時返回的是數字 0 還是 null、枚舉字段新增狀態後前端 switch 有沒有兜底分支、以及權限失敗時有沒有把後端內部堆棧直接暴露進響應體。

常見問題

問:項目沒用 openapi.yaml,前後端都是 TypeScript 用 Zod 怎麼套這個流程?

答:完全一樣的道理。把共享的 packages/contracts/invoice.schema.ts 當作第一步先審定的契約文件,前後端同時 import 它推導出來的 z.infer 類型,甚至連代碼生成腳本都省了。

問:已有老項目根本沒有契約文檔,怎麼補第一份?

答:先讓只讀子代理掃描後端現有的 Controller 路由與 DTO 類,反向抽取生成第一版基準 openapi.yaml,跑通一次響應比對確認與線上現狀一致後,從下一個新需求開始執行契約先行。

問:智能體被 deny 攔住改不了 generated/ 目錄時會卡死嗎?

答:不會卡死。看到權限拒絕提示後,它會意識到那是生成物目錄,轉而去讀你在 CLAUDE.md 裏寫明的「改契約後運行 npm run gen:api-types 重新生成」指令走正規途徑更新。

問:後端已經用 NestJS 或 FastAPI 裝飾器自動吐出 OpenAPI JSON,還需要手寫 openapi.yaml 嗎?

答:代碼優先(Code-first)框架不需要維護兩份重複的 YAML。你可以把順序微調成「先讓後端子代理只寫 DTO 數據模型類與路由空殼 → 運行導出腳本生成最新 openapi.json 給前端導類型 → 前後端再並行填滿數據庫查詢與頁面渲染細節」,核心依然是先鎖死接口形狀、禁止前端手敲野生類型。

問:聯調時前端需要假數據看頁面效果,怎麼防止 Mock 數據寫死忘刪?

答:要求前端子代理統一使用基於 OpenAPI 自動生成的 Mock 攔截層(如 MSW),通過環境變量開關控制僅在本地開發態掛載,嚴禁在業務組件代碼裏直接硬編碼假數組返回。

問:國內沒有海外銀行卡,怎麼給 Claude Code 開通 Pro 或 Max 訂閱最穩妥?

答:可在 Claude Code 訂閱說明頁 或 Claude Max 充值頁 選擇走蘋果 iOS 官方內購鏈路的自助卡密,自己複製登入憑證提交即可到賬,全程無需把密碼交給他人;若帳號偶發彈出身份核驗,也可查看 Claude KYC 人工協助(失敗不收費,封號不在質保範圍)。

相關教學

Nathaniel 的更多內容

  1. 01

    獨立開發者用 ChatGPT + Codex 跑通產品全流程:市場驗證、PRD、原型到代碼上線覆盤清單

    單人做獨立產品最容易陷入「閉門寫兩個月代碼上線零用戶」或「AI 寫到一半目錄越改越崩」。本文整理「ChatGPT 負責市場驗證、PRD 與覆盤 + Codex 負責工程實現與測試」的五階段雙軌流程,附起手提示詞與 7 項上線覆盤清單。

    ChatGPTCodex0
  2. 02

    用 ChatGPT 批量生成規範文件命名規則、整理混亂目錄樹與合併零散發票抬頭清單腳本

    面對滿桌面的「新建文件夾」「最終版2」和上百張零散電子發票,手工改名抄台帳耗時又容易漏重。本文分享先脫敏取樣、再用 ChatGPT 生成帶預演和回滾日誌的本地 Python 腳本,離線安全完成目錄整理與發票抬頭合併去重的實戰流程。

    ChatGPT0
  3. 03

    用 ChatGPT 做海外電郵營銷(EDM)受眾分層文案、A/B 主題行測試與防進垃圾箱自檢

    做海外獨立站或出海 SaaS 電郵營銷(EDM),最怕千人一面群發被直接送進垃圾箱。本文結合 Gmail/Yahoo 批量發件人規範,梳理用 ChatGPT 設計受眾分層文案、批量生成 A/B 主題行矩陣並開展發前垃圾詞與合規自檢的實戰提示詞。

    ChatGPT0
  4. 04

    用 ChatGPT 寫 Notion Formula 2.0 公式、Obsidian Dataview 查詢與 Airtable 自動化腳本

    給 Notion 數據庫寫多條件 Formula 2.0 公式、給 Obsidian 寫 Dataview 動態看板,或在 Airtable 裏寫自動化腳本,經常因為一個小括號或類型不匹配報錯半天。本文整理三大工具的通用上下文喂料規範與三套直接可複製的生成提示詞。

    ChatGPT其他 AI 工具0
  5. 05

    用 ChatGPT 處理複雜 JSON / YAML / XML 字段映射、格式轉換與校驗規則編寫實戰

    對接第三方 API、遷移 Kubernetes 配置或解析政企 XML 報文時,手工對照幾百行嵌套字段既慢又容易漏掉空值與類型邊界。本文整理用 ChatGPT 完成字段映射表梳理、生成確定性轉換腳本以及編寫 JSON Schema / Pydantic / XSD 校驗規則的實戰流。

    ChatGPT其他 AI 工具0
  6. 06

    用 ChatGPT 準備本科/碩士畢業論文答辯:提煉答辯 PPT 結構、模擬導師犀利追問與 3 分鐘自述稿

    畢業論文寫完後,要在 3–5 分鐘內講清研究價值並頂住答辯評委的連環追問並不輕鬆。本文整理在嚴格遵守高校學術規範的前提下,用 ChatGPT 提煉答辯 PPT 結構、打磨 3 分鐘口語自述稿並開展模擬導師犀利追問的排練流程與提示詞。

    ChatGPT0

同模型

  1. 01

    Anthropic Contextual Retrieval(上下文增強檢索)是什麼、怎麼實現:給文檔塊自動補背景摘要結合緩存降失誤率

    長文檔切成小塊後丟了公司名、年份和主語指代導致 RAG 頻頻搜錯?本文按 Anthropic 官方技術文章詳解 Contextual Retrieval 原理、官方公開評測失誤率下降 49% 至 67% 的組合架構,以及用 Claude 提示詞緩存低成本批量生成切片背景的完整 Python 代碼。

    Claude其他 AI 工具0
  2. 02

    寫代碼兼顧辦公,同時訂「ChatGPT Plus + Claude Pro 雙會員」還是單上「Max / Pro 高階檔」怎麼算帳

    每月花 $40 同時訂 ChatGPT Plus + Claude Pro 雙會員,還是花 $100 單上 Claude Max 或 ChatGPT Pro 100?本文按兩家官方定價頁拆解編程智能體、多模態辦公、限額容災與獨佔功能帳本,給出清晰選型公式。

    ChatGPTClaude0
  3. 03

    Notion AI 怎麼收費、包含在套餐裏還是單獨買:工作區知識問答、數據庫自動填表與對比 Claude / ChatGPT 選型

    Notion AI 現在還能單獨加購嗎?按 Notion 官方現行定價頁,完整 Notion AI 已直接打包進 Business(年付 $20/成員/月,月付 $24)與 Enterprise 套餐,Free 和 Plus 僅含少量試用。本文講清計費變化、三大核心功能及與獨立會員的取捨。

    其他 AI 工具0
  4. 04

    Raycast AI(Pro / Pro+ / Max)是什麼、怎麼配 BYOK 自帶密鑰:快捷呼出 Claude 與 GPT 桌面工作流

    Raycast AI 支持在桌面端全局快捷鍵呼出 Claude、GPT 與 Gemini。本文按官方手冊說明 Raycast Pro、Pro+、Max 積分檔位差別,以及配置 BYOK(自帶 API 密鑰)的前置條件、設定步驟與快捷指令工作流。

    其他 AI 工具0
  5. 05

    Perplexity Pro 值得買嗎:每月 $20 比免費版多什麼、可選哪些 Claude / GPT 模型與深度檢索用法

    Perplexity Pro 月付 $20(年付約 $17/月),比免費版多出高配額 Pro 搜尋、切換 Claude 與 GPT 模型及更高頻的 Deep Research 深度檢索。本文對比各檔權益,幫你判斷訂它還是獨立對話會員。

    其他 AI 工具0
  6. 06

    Claude API Citations 原文引用結合 Files API 搭建可溯源企業制度問答指南

    搭公司內部報銷、法務或操作規程問答機器人,不想折騰複雜的切片向量數據庫又怕大模型胡編頁碼?本文按 Anthropic 官方文檔詳解用 Files API 傳一次 PDF 拿 file_id,結合 Citations 原生返回精確頁碼與原文摘錄的完整架構。

    Claude0

同產品的其他教學

  1. 01

    用 ChatGPT 速讀英文產品手冊、開源文檔與 GitHub Issue 並沉澱團隊中文內訓手冊

    團隊引入海外 SaaS 工具或開源框架時,全英文文檔晦澀冗長、真正的坑全藏在幾十頁 GitHub Issue 討論裏。本文分享速讀拆解英文手冊、歸類 Issue 排障庫以及重構團隊中文內訓 SOP 的完整實戰流程。

    ChatGPT其他 AI 工具0
  2. 02

    用 ChatGPT 寫油猴腳本(Tampermonkey)與瀏覽器書籤小工具解決網頁繁瑣重複操作實戰

    每天在後台系統裏重複勾選幾十個複選框、手工複製網頁表格或清理遮擋閱讀的側邊欄,既枯燥又浪費時間。本文分享不會寫 JS 也能用 F12 配合 ChatGPT 寫出油猴腳本與書籤小工具的完整實戰流程。

    ChatGPT其他 AI 工具0
  3. 03

    用 ChatGPT 寫高質素 SQL 窗口函數(RANK / LAG / SUM OVER)做留存與漏斗分析實戰

    做用戶留存率、復購間隔與有序轉化漏斗時,多層自連接既難讀又拖垮數據庫,窗口函數則是高效解法。本文整理數據庫方言喂數規範、CTE 分層提示詞以及用內置沙盒先驗證再上線的完整實戰流程。

    ChatGPT其他 AI 工具0
  4. 04

    ChatGPT 連接 Canva、Figma、Linear、Jira、Dropbox 等第三方應用搜不到數據或授權失效怎麼辦

    在 ChatGPT 接入 Canva、Figma、Linear、Jira 或 Dropbox 後,明明顯示已連接卻搜不到文件工單,或老提示授權失效怎麼辦?本文拆解帳號錯綁、OAuth 範圍漏選、權限繼承與管理員攔截 5 步排障法。

    ChatGPT其他 AI 工具0
  5. 05

    RAG 知識庫回答不準怎麼調優:切片大小(Chunking)、BM25 + 向量混合檢索與 Rerank 重排序三步排查法

    搭好的 RAG 企業知識庫一問具體型號、報錯碼或跨行表格就答非所問?本文按 OpenAI 與 Anthropic 官方檢索文檔,給出先隔離檢索與生成故障、再按結構化切片(Chunking)、BM25 加向量混合召回(RRF)與 Rerank 重排序逐層調優的三步法。

    Claude其他 AI 工具0
  6. 06

    Langfuse 開源本地部署(Docker Compose)與提示詞版本管理(Prompt Management)從零上手教學

    企業內網嚴禁業務日誌出境,又想免費擁有大模型調用鏈追蹤與不發版熱更新提示詞的能力?本文按 Langfuse 官方文檔整理 Docker Compose 本地一鍵啟動(含 ClickHouse 架構注意事項)、密鑰配置與 Prompt Management 標籤化版本管理全流程。

    Claude其他 AI 工具0

0 條評論

登入 後參與評論

還沒有評論,來搶沙發~