[ADP-22] API 優先 (API First)
reviewing phase 1
這篇文章需要更多參考資料以及實際內容。
概述
API 優先本質上是「契約優先」(contract-first)。整個團隊從一開始就協作建立契約。這允許前端工程師、後端工程師和測試程式設計師在遵守約定契約的同時獨立進行他們的實作。
API 優先的好處
- 提高開發效率
- 增強團隊協作
- 確保 API 一致性
- 降低後期修改成本
API 優先與 ADP
在使用 API 優先方法設計和審查 API 時,尋找最佳實踐或從頭創建新的實踐可能會耗費時間。通過閱讀 ADP 並與您的 API 審查者討論,您可以節省時間並確保您的 API 設計符合既定標準和最佳實踐。
注意: ADP 代表 API 設計原則 (API Design Principles),即本系列文章,為確保組織內 API 設計一致性的指導原則。
參考
API 的啟發性引言
API 是一個承諾。 來源
An API is nice to be important, but more important to be nice. 來源
API
- 應該在技術上正確
- 對客戶端信守承諾,永不違約
- 應該尊重、禮貌
- 使契約更加愉快
- https://www.youtube.com/watch?v=twfufQn1mD0