P86 JSONの項目名の命名規則

JSONではキャメルケースを利用した方が良い。理由としては、JavaScriptの命名規約においてキャメルケースの利用をルール付けしているケースが多いため。

とはいえ、Twitter,Facebook,Instgramなどスネークケースを用いているAPIも多い。

一番重要なのは、API全体を通して統一するという事である。

 

また、変な省略形は極力利用しない。データ転送量の都合でどうしても少なくする事はあるかもしれないが、極力略語は用いずに短く分かりやすい名称付けをすること。

 

最後に 単数形、複数形に気をつけ、使い分けること。googleJSONスタイルガイドのようにデータを配列で返す場合は複数形、それ以外は単数形にする という明快さにしてもよい。

 

Web API: The Good Parts

Web API: The Good Parts