[ADP-1] ADP 目的

目標

• 本文件的目標之一是建立一個標準，使公司內的每位 API 設計師都能創建看似由同一個人設計的 API。
• 確保所有 API 設計都遵循統一的最佳實踐和指南，促進所有項目的一致性和品質。
• 通過提供 API 設計的通用規範與建議，促進團隊間的更好協作，使不同業務單位的 API 更容易理解和整合。
• 確保 API 設計同時優先考慮開發者體驗和最終用戶體驗，創建更穩健和用戶友好以及開發者友好的應用程序。
• 提升整個組織 API 的整體安全性和可靠性。
• 透過公開設計規範促進 API as a product/API First 的重要性。
• 方便開發者們溝通交流。

寫作指導原則

參見 ADP 寫作指導原則

違反指導原則

• 如果您需要違反某些指導原則，您可以指定違反的 ADP。

  TIP

  💡 如果有充分理由違反，您應該為本文件提供反饋，以考慮對整體規範進行更改。