by @mixiappwchr アプリ向けのAPIの開発時に気をつけてもらえるとうれしい&メンテナンスや実装コストが下がる点をつらつら書きます。 データ構造について データを返すとき、一定のルールを守って返す。例えば当然ですが同じデータ構造はもちろん、似たような構造もルールを作ってproperty名などそろえておく。relationやlistで返すときもどのデータ構造なのかがpropertyで明確にわかるようなっているようにする listを返す場合の形式やpagingが必要な場合の形式はそろえる。配列のデータがない場合も考慮しておく。例えば、データがない場合にNULLにするか or 空配列にする or property自体がないなどきめる pagingの場合とか複数のパターンが存在することを覚えておくと幅が広がる。単純なページング or twitterみたいなsince_idなど起点id以
![アプリエンジニアから見てAPI設計において気をつけてもらえるとうれしいこと - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/d97e043858c1e3bec9248809e9dcdd6d3af82137/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9JUUzJTgyJUEyJUUzJTgzJTk3JUUzJTgzJUFBJUUzJTgyJUE4JUUzJTgzJUIzJUUzJTgyJUI4JUUzJTgzJThCJUUzJTgyJUEyJUUzJTgxJThCJUUzJTgyJTg5JUU4JUE2JThCJUUzJTgxJUE2QVBJJUU4JUE4JUFEJUU4JUE4JTg4JUUzJTgxJUFCJUUzJTgxJThBJUUzJTgxJTg0JUUzJTgxJUE2JUU2JUIwJTk3JUUzJTgyJTkyJUUzJTgxJUE0JUUzJTgxJTkxJUUzJTgxJUE2JUUzJTgyJTgyJUUzJTgyJTg5JUUzJTgxJTg4JUUzJTgyJThCJUUzJTgxJUE4JUUzJTgxJTg2JUUzJTgyJThDJUUzJTgxJTk3JUUzJTgxJTg0JUUzJTgxJTkzJUUzJTgxJUE4JnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmdHh0LWNsaXA9ZWxsaXBzaXMmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz01NjYwYWI1ZmY5Y2E5NjBkMjQxY2I0MjE4MTdmNmE1NA%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwYXBwd2F0Y2hlciZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9MWY2NTI3NDJiY2E0NTNkMDNmMWRhYjkwMTg2NTlmN2Q%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D8f5ea965b1ef86923c985bf990bd244e)