[ADP-601] 作為 API 設計一部分的事件
指導方針
- 應(SHOULD)將事件視為 API 設計中的一等公民。
- 應(SHOULD)將事件設計作為 API 設計過程中的自然部分。
- 應(SHOULD)使用一致的事件格式。這裡我們選擇 JSON 作為事件格式。
- 應(SHOULD)保持事件的向後兼容性。
- 應(SHOULD)在集中式架構註冊表中註冊事件架構。
- 應(SHOULD)追蹤事件。
- 應(SHOULD)考慮事件的安全性和隱私性。
- 應(SHOULD)確保事件處理是冪等的。
- 應(SHOULD)詳細記錄事件，包括其目的、結構和用法。
- 應(SHOULD)為事件架構提供清晰的版本控制。
- 應(SHOULD)實施事件處理失敗的監控和警報。
- 應(SHOULD)確保事件設計具有可擴展性和彈性。
設計思考
事件通常由事件生產者產生，並透過特定 API 被事件消費者接收。隨著系統的成長，事件的數量和複雜性預計會增加。如今，許多系統不僅透過傳統的 API 數據交換進行整合，還透過即時事件進行整合。
這種轉變突顯了將事件設計作為 API 設計不可或缺部分的重要性，確保系統能夠有效地處理和回應動態、即時的數據流。通過將事件視為 API 設計中的一等公民，開發人員可以創建更具回應性、可擴展性和彈性的系統，更能應對現代事件驅動架構的需求。