オブジェクトがひとつのときのJSONデータのリクエストまたはレスポンスについて

Question

オブジェクトが複数のとき、JSONデータはリスト型になると思います。

[
{
"id" : 1
},
{
"id" : 2
},
{
"id" : 3
}
]

一般的に、オブジェクトがひとつのとき、JSONデータのリクエストまたはレスポンスはリスト型で送信すべきでしょうか。リスト型にしない方がよいでしょうか。

リストの場合

[
{
"id" : 1
}
]

リストでない場合

{
"id" : 1
}

DjangoでAPIを作成しているのですが、リクエストのJSONが常にリスト型であることを想定して作るべきか、レスポンスデータはオブジェクトがひとつの場合でも常にリスト型すべきなのか、など迷っています。

Answer 1

複数返す可能性があって、たまたま１つしか返さない場合
・・・というならリスト型でよいでしょう。
どうしたらいいかではなく、どうしたいかの問題です

Comments

[sasaki0628]

常にひとつのオブジェクトをリクエストで送信され、常にひとつのオブジェクトをレスポンスする、というAPIを作成する場合に、リストで受け入れる形を作り、リストでレスポンスをするというのは一般的には不自然でしょうか。一般的なAPIやJSONのコーディング規約があるとうれしいのですが…。なるべく一般的な形に従いたいと思っています。

[yambejp]

「常にひとつのオブジェクトをレスポンス」であれば辞書型で十分ですね。
リスト型でレスポンスするのは不自然・・・というか何か目的か理由がなければそういう実装にはならないと思います。
配列で返すか、オブジェクトで返すかという命題に「一般的」という概念を持ち込む必要はありません。あえていえばどちらも一般的です。

[sasaki0628]

ありがとうございました。色々とAPIのレスポンスデータを調べた結果、オブジェクトがひとつと限られている場合にもリストを使うと不必要に階層が深くなるため、不自然と感じました。特殊な事情ありき、ということですね。