JSON を返す API のキー名のルール
◆ 変数名は foo_bar 形式にしてるので API で使う JSON のキーも foo_bar 形式にしたい
◆ 世間のサービスだと fooBar 形式のほうが多いような気がする
◆ foo_bar 形式を使ってるサービスを探してみると結構有名どころも使ってた
◆ 世間のサービスだと fooBar 形式のほうが多いような気がする
◆ foo_bar 形式を使ってるサービスを探してみると結構有名どころも使ってた
API で受け取る JSON のキーの命名規則ってどういうのが多いんでしょうか
JavaScript 自体は fooBar 形式なので ライブラリとかを見るとこのタイプが多いようです
ただ私は基本的な変数は foo_bar 形式で関数は fooBar 形式です
JSON の値に関数は来ないですし API で受け取るデータから変数に移すときに命名規則を変えるなんてことはしたくないので foo_bar 形式に揃えたいところです
またデータベースを考えると RDB の列名には fooBar よりも foo_bar が多い気がします
(RDB じゃなくて JSON をそのまま保存するデータベースだと fooBar もありそうな気はしますけど)
データベースから取り出してレスポンスにする過程でわざわざ命名規則を変更する必要もないのでやっぱり foo_bar 形式にしたいです
世間のサービス的にはやっぱり fooBar 形式が多いんでしょうか
foo_bar 形式を使ってるサービスは少ないんでしょうか
探してみるとけっこう foo_bar 形式も多いようで安心しました
https://docs.github.com/ja/rest/guides/getting-started-with-the-rest-api
html_url
pull_request
など foo_bar 形式です
Google
Google では JavaScript で使う前提の JavaScript API は fooBar 形式になっていました
ただ JavaScript に縛られないものとして Google Maps のジオコーディング API を見てみると foo_bar 形式でした
https://developers.google.com/maps/documentation/geocoding/requests-geocoding
long_name
formatted_address
などがあります
Twitter
SNS の情報取得にも API がよく使われると思うのでとりあえず Twitter を見てみました
https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all
end_time
max_results
など foo_bar 形式です
Facebook
もうひとつ SNS で Facebook も見てみました
https://developers.facebook.com/docs/graph-api/overview
created_time
のようにこっちも foo_bar 形式です
https://help.blogpark.jp/archives/52491176.html
is_root
is_file
のように foo_bar 形式です
https://webservices.amazon.com/paapi5/documentation/search-items.html
PartnerTag
PartnerType
という感じです
AWS の API と同じですね
https://docs.aws.amazon.com/ja_jp/cli/latest/userguide/cli-usage-skeleton.html
このサービスだってこの形式なんだからと自信を持って言えますね
JavaScript 自体は fooBar 形式なので ライブラリとかを見るとこのタイプが多いようです
ただ私は基本的な変数は foo_bar 形式で関数は fooBar 形式です
JSON の値に関数は来ないですし API で受け取るデータから変数に移すときに命名規則を変えるなんてことはしたくないので foo_bar 形式に揃えたいところです
またデータベースを考えると RDB の列名には fooBar よりも foo_bar が多い気がします
(RDB じゃなくて JSON をそのまま保存するデータベースだと fooBar もありそうな気はしますけど)
データベースから取り出してレスポンスにする過程でわざわざ命名規則を変更する必要もないのでやっぱり foo_bar 形式にしたいです
世間のサービス的にはやっぱり fooBar 形式が多いんでしょうか
foo_bar 形式を使ってるサービスは少ないんでしょうか
探してみるとけっこう foo_bar 形式も多いようで安心しました
Github
まずはとりあえず有名どころの Github を見てましたhttps://docs.github.com/ja/rest/guides/getting-started-with-the-rest-api
html_url
pull_request
など foo_bar 形式です
ただ JavaScript に縛られないものとして Google Maps のジオコーディング API を見てみると foo_bar 形式でした
https://developers.google.com/maps/documentation/geocoding/requests-geocoding
long_name
formatted_address
などがあります
https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all
end_time
max_results
など foo_bar 形式です
https://developers.facebook.com/docs/graph-api/overview
created_time
のようにこっちも foo_bar 形式です
ライブドアブログ
このブログはライブドアブログなのでここはどうなんだろうと見てみましたhttps://help.blogpark.jp/archives/52491176.html
is_root
is_file
のように foo_bar 形式です
Amazon
Amazon は少し珍しく FooBar 形式でしたhttps://webservices.amazon.com/paapi5/documentation/search-items.html
PartnerTag
PartnerType
という感じです
AWS の API と同じですね
https://docs.aws.amazon.com/ja_jp/cli/latest/userguide/cli-usage-skeleton.html
まとめ
有名どころでも foo_bar 形式があって安心しましたこのサービスだってこの形式なんだからと自信を持って言えますね