web-dev-qa-db-ja.com

REST APIレスポンスのnullと欠落したキー

私のアプリケーションで、ユーザーによっては姓を教えてもらえない人もいます。 REST APIレスポンスでは、どちらのボディが推奨されますか：

「null」値の場合：

{"firstName": "Bob",
 "lastName": null}

または、不足しているキー：

{"firstName": "Bob"}
restapi-designjson
43
jtmarmon

空またはnull値を削除することを検討してください。

プロパティがオプションであるか、空またはnull値がある場合は、その存在に強い意味上の理由がない限り、JSONからプロパティを削除することを検討してください。

{
  "volume": 10,

  // Even though the "balance" property's value is zero, it should be left in,
  // since "0" signifies "even balance" (the value could be "-1" for left
  // balance and "+1" for right balance.
  "balance": 0,

  // The "currentlyPlaying" property can be left out since it is null.
  // "currentlyPlaying": null
}

さらに読む
Googleスタイルガイド-空またはnullのプロパティ値
REST API？ からのJSON応答にnull値を含める必要がありますか？

33
Robert Harvey