クライアントアプリの為のREST API設計 - Qiita

エンジニアがアプリ担当とAPI担当で分かれているチームで、API担当のエンジニアがアプリ開発経験が無かったりすると、アプリ担当のエンジニアはどんなAPIがクライアントアプリにとって使いやすいのか、上手く伝えるのに苦労する事がありますよね?本記事はそんな場面でAPI担当のエンジニアに読んでもらう事を想定しています。 APIと型 アプリ側はRESTクライアントにRetrofitやRestkit等、既に広く使われているライブラリを使用する事が多いです。それらのライブラリは、オブジェクト・JSON間の変換機能があり、アプリ側ではJSON等シリアライズされるデータ形式を意識せずに、処理系上のオブジェクトをそのまま扱えます。即ちAPI経由でやり取りされるデータは全て型を持つのです。 例えばAPI側のコードで以下の様に定義されたクラスが

[JHashimoto]

“もしここで、「いやウチはAPI経由でやり取りしたデータはHashのまま引き回しているんだけど...」という方がいらっしゃいましたら、その設計は問題を抱えているので早急に見直す事をお勧めします。”

[tetsukamp]

同意[android][client-app][api]

[izumin5210]

JSもキャメルだから統一したほうが良さそうだ “スネークケース vs キャメルケースに関してはアプリ側はAndroid,iOS共キャメルケースの文化なので、データオブジェクトのメンバはキャメルケースであるべき”

[Mint0A0yama]

“「いやウチはAPI経由でやり取りしたデータはHashのまま引き回しているんだけど...」という方がいらっしゃいましたら、その設計は問題を抱えているので早急に見直す事をお勧めします”

[androidzaurus]

あとで読む

[h5y1m141]

おー、誰かと思ったら、なかがわさんだ！

[itochan315]

すごく同意