Skip to content
ADP
API Design PrincipleBETA

[ADP-21] 最佳實踐

reviewing phase 1

這篇文章需要更多參考資料跟實際內容。

設計思維

即使我們已經制定了初始和發展中的原則,仍可能存在一些未涵蓋的方面。這可能是由於制定原則後出現的新標準,或是我們當前無法預料的新需求。

舉例來說,OpenAPI 本身並不描述如何處理非同步請求,這一點由 AsyncAPI 來補充。此外,如果我們將來決定同時支持 REST 和 GraphQL,儘管 GraphQL 沒有通用規範,我們仍可以通過集體討論,從 IEEE RFC或網上可用的資料中找出最佳實踐。在創造新解決方案之前,應先確定是否已有行業標準或常見慣例可以解決你的問題或滿足你的需求。

除了API設計,實施細節也是一個重要方面。在決定為標準編寫新函式庫之前,請尋找相關的套件、庫和討論,並評估這些解決方案是否適合您的產品/應用程序。

指導原則

  • 應該(SHOULD)調研行業標準或常見慣例的最佳實踐。
  • 如果您認為現有標準無法滿足您的需求,應該(SHOULD)設計並請求內部意見(RFC),並致力於將其發展成為最佳實踐。
  • 應該(SHOULD)記錄您的內部RFC。
  • 你應該(SHOULD)定期審查和更新最佳實踐,以確保它們與行業趨勢和組織需求保持一致。