Architecture Decision Record架構決策記錄：REST API 用 snake_case 定 camelCase？
決策：REST API 端點會用 snake_case 命名慣例
狀態：已接納
背景
REST API 嘅命名慣例有兩種流行格式：snake_case 同 camelCase。snake_case 格式係名稱入面每個字都用底線分隔，而 camelCase 係名稱嘅第一個字用小寫，其後每個字嘅首字母大寫。呢個決策會決定 REST API 應該用邊種命名慣例。
決策驅動因素
同項目現有命名慣例一致
令任何可能參與 API 工作嘅人都易讀易明
符合業界 REST API 命名慣例嘅最佳做法
易於實施同維護
決策
REST API 端點會用 snake_case 命名慣例。呢個選擇由以下因素驅動：
一致性：項目已經對所有端點用 snake_case 命名慣例，維持呢個慣例對確保整個項目嘅一致性有好處。
可讀性同清晰度：snake_case 慣例更易讀、更易明。底線令字與字之間有清晰嘅分隔，更易解析同理解名稱嘅意思。
符合業界最佳做法：snake_case 慣例喺業界廣泛使用，被視為 REST API 嘅最佳做法，令佢成為項目嘅好選擇。
易於實施同維護：沿用現有命名慣例更易實施同維護，因為如果揀選新慣例，所有現有程式碼同文件都需要更新。
後果
呢個決策有一些潛在後果。
如果有新加入項目嘅團隊成員唔熟悉 snake_case 命名慣例，可能會導致開發上嘅混淆同錯誤。不過，由於 snake_case 係廣泛使用嘅慣例，呢種風險極低。
如果項目入面使用嘅其他工具或者框架嚴重依賴 camelCase 慣例，可能需要額外工夫喺命名慣例之間轉換。不過，由於項目已經標準化採用 snake_case 慣例，呢點並非重大關注。
總括而言，REST API 端點採用 snake_case 命名慣例嘅決策，帶來一致、易讀而且符合業界標準嘅做法，同時易於實施同維護。