Skip to content

E3:契約優先開發

先寫程式再補文件的做法有幾個問題:API 行為由實作決定而非設計決定,文件永遠落後於程式碼,口頭約定的介面細節容易遺漏。

契約優先開發要求在實作前定義 API 契約,讓前後端可以平行開發,介面邊界清楚,測試有依據。

原則

  • 所有團隊必須 (MUST) 實踐 API 優先、規格優先、契約優先文化。

在 API 設計階段產出的 OpenAPI 規格是機器可讀契約,AI 代理可以理解、生成與驗證。API 優先開發的紀律直接啟用有效的 AI 協作。明確的契約讓前端與後端開發可以獨立進行。

相關原則

參考資料