Web APIのレスポンスにおいてエンベロープは必要か

Web API のレスポンスのjsonにエンベロープは必要でしょうか？

teratailのAPIのレスポンスでは以下のようにエンベロープが存在します。

json
1{
2  "meta": {
3    "message": "success"
4  },
5  "question": {
6  ...

qiitaの場合は存在しません。

json
1[
2  {
3    "description": "Hello, world.",
4    "facebook_id": "yaotti",
5    "followees_count": 100,
6    "followers_count": 200,
7    ....

みなさんはどちらの方法を採用していますか？

また、ページネーションに関してもHTTPヘッダに埋め込むかjsonに埋め込むかでわかれるところではあると思いますがいかがでしょう？

API設計の参考になるサイト等も回答いただければと思います。

行動規範の内容に同意します

回答1件

ベストアンサー

これは時と場合にもよりますが、基本はqiitaのようにフラットな方がいいと思います。
エンベロープを単に複数項目を一つのカテゴリにまとめたい場合に使うと扱いが悪くなるので、無理に使わない方がいいです。
フラットな場合に、他のレスポンスデータと似通ったデータなどがあり人間が見てごっちゃになりやすいもののみエンベロープで括る場合に多少のメリットがあるぐらいでしょうか。（ある程度規模が大きい場合に使うと有効）。あとはメリットが思いつきません。

投稿2015/11/21 19:17