[ADP-20] 工程原則

reviewing phase 1

這篇文章需要更多的參考資料以及實際內容

API 優先是我們期望的核心工程原則之一。本文概述了 API 優先原則以及幾個相關或值得一提的工程原則。

原則列表

API 優先

API 優先是一種開發方法，在實現底層系統之前優先考慮 API 的設計和開發。主要方面包括:

在編寫任何代碼之前設計 API
使用 OpenAPI (Swagger) 等 API 描述格式
確保所有 API 的一致性
促進前端和後端系統的並行開發
使用 API 測試和驗證

查看API優先

DevOps 和持續集成/持續部署 (CI/CD)

自動化 API 測試和驗證
實現 API 變更的快速迭代和部署
促進開發、測試和生產環境的一致性

文件即代碼

將 API 文件與代碼一起維護
從 API 規範自動生成和更新文件
確保文件與 API 變更保持同步

安全設計

將安全性整合到 API 設計過程中:

實施適當的身份驗證和授權機制
確保數據隱私和保護
定期進行 API 安全審計

版本控制和向後兼容性

查看版本控制

開發者體驗 (Developer Experience)

查看開發者體驗

採用最佳實踐

查看最佳實踐

指導方針

團隊應將這些原則適當地納入其開發工作流程中，確保在整個軟體開發生命週期中優先考慮 API 設計。
應定期審查和更新這些原則，以反映不斷發展的最佳實踐、技術和團隊經驗。鼓勵所有團隊成員提供反饋和改進建議。