2011-11-16 9 views
1

私たちは、クライアントがHTTP POST APIを介して対話できるようにする、小さなWebアプリケーションをRailsに構築しています。典型的なクライアントは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 

我々はすべての3つのオプションがHTTP POSTで技術的に許容されるが、我々は他の上の1つを使用することによって避けることができ、技術的な落とし穴があることを理解できますか?たとえば、ドットを使用しないでください。 "プログラミング言語内での「ドット表記法」の普遍的な使用によるフィールド名の使用

アドバイスをいただければ幸いです。

答えて

0

最終的には、あなたとあなたの開発者が最も快適になるものになります。私は個人的にすべての変数、HTTP_POSTまたはプログラミングにcamelCaseを使用します。私はラクダにこだわるだろうケースやスネークケース、キャメルケースが最も人気があります。

ドット表記法は命名規則の最悪の形式の1つで、その理由を述べました。関数やその他のオブジェクト関連のタスクにドット表記を使用するフォーム上で言語を使用すると、問題が発生する可能性があります。 EX:javascript - 良い例ではありませんが、ほとんどの関数はドット表記です。