2011-11-16 23 views
1

我們正在Rails中構建一個小型Web應用程序,它將允許客戶端通過HTTP POST API進行交互;一個典型的客戶端是另一個應用程序,如HTML表單或移動應用程序。HTTP POST參數命名約定的首選項?

我們正在決定API字段名稱,即POST參數名稱。我們想知道是否有一個特定的命名約定,我們應該去?例如。 snake_case,駝峯等

一些例子:

OPTION 1 
employee.address.line_1=value 

OPTION 2 
employee_address_line_1=value 

OPTION 3 
employeeAddressLine1=value 

我們明白,所有這三個選項是技術上允許在HTTP POST,但是否有任何技術缺陷,我們能夠避免通過使用一個比其他?例如,我們應該避免使用點「。」由於在編程語言中無處不在使用'點符號'而在字段名稱中出現?

任何意見將不勝感激。

回答

0

它最終歸結於您和您的開發人員最喜歡的。我個人使用camelCase來處理所有變量,HTTP_POST或編程。我會堅持使用camelCase或snake_case,雖然camelCase最受歡迎。

點符號是命名約定中最糟糕的形式之一,你說明了原因。如果您碰巧在窗體上使用任何語言來爲函數或其他對象相關任務使用點符號,則可能會遇到問題。 EX:javascript - 不是一個很好的例子,但是大多數函數都用點符號表示。