アプリエンジニアから見てAPI設計において気をつけてもらえるとうれしいこと - Qiita

by @mixiappwchr アプリ向けのAPIの開発時に気をつけてもらえるとうれしい＆メンテナンスや実装コストが下がる点をつらつら書きます。 データ構造について データを返すとき、一定のルールを守って返す。例えば当然ですが同じデータ構造はもちろん、似たような構造もルールを作ってproperty名などそろえておく。relationやlistで返すときもどのデータ構造なのかがpropertyで明確にわかるようなっているようにする listを返す場合の形式やpagingが必要な場合の形式はそろえる。配列のデータがない場合も考慮しておく。例えば、データがない場合にNULLにするか or 空配列にする or property自体がないなどきめる pagingの場合とか複数のパターンが存在することを覚えておくと幅が広がる。単純なページング or twitterみたいなsince_idなど起点id以

[escape_artist]

「API」ってWebAPIの意味？

[kamm]

一番間違いないのは、アプリのエンジニアにAPIの仕様を作ってもらうことです。たたき台として。そこからお互いに調整。

[crist18]

API

[hatajoe]

こういうの嬉しい。勉強になります。

[t-wada]

アプリケーション向けに提供する Web API を設計する際に留意すべき点が記されている。特にデータ構造や実運用時に向けたノウハウが実践的ですばらしい

[anoworl]

スマホアプリから叩くサーバ側APIの設計について

[dekokun]

Web APIについて考えておくべきことってのはこんなかんじで手元にリファレンスの形で持っておかないとすぐに脳内から揮発してしまうよな〜

[tooooomin]

あとでよむ

[bonty_shushusha]

アプリエンジニアから見てAPI設計において気をつけてもらえるとうれしいこと

[usami-k]

データ構造についての項目は、これを考慮してもらえるかどうかでアプリ側の実装の負担は大きく変わってくる、大事なポイント。アプリ運用や負荷対策の項目も参考になる。

[ryonext]

参考になる。

[KeithYokoma]

うむ。