64

RESTful API の設計と開発を行っています。私は、API に対して実用的なリソース指向のアプローチを採用しています (リソース指向、統一されたインターフェイス、アドレス可能性ですが、実際の HATEOAS はありません)。ただし、よくわからない点の 1 つは、オブジェクトの null 値にアプローチする方法です。

API 応答に null 値を持つフィールドを含める必要がありますか?

例：

{
    "fieldA": "AAA",
    "fieldB": null
}

または、システムにこれらのフィールドのデータがない場合、これらのフィールドを完全に除外する必要がありますか?

例：

{
    "fieldA": "AAA"
}
4

2 に答える 2

37

これについては、最近API-Craftで議論がありました。一般的なコンセンサスは、値の省略と null 値の組み込みとの間に意味上の違いがある可能性があるというものでした。

特定のユースケースで得られるセマンティックな値がない場合は、API のターゲット コンシューマーを見て、値を省略すると問題が発生するかどうかを検討してください。

于 2013-03-28T16:27:34.367 に答える