it-swarm.com.de

null vs fehlender Schlüssel in REST API-Antwort

Angenommen, in meiner Anwendung geben einige Benutzer ihren Nachnamen an, andere nicht. In einer REST API-Antwort, welcher Textkörper wird bevorzugt:

Mit einem "Null" -Wert:

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

Oder nur ein fehlender Schlüssel:

{"firstName": "Bob"}
43
jtmarmon

Entfernen Sie möglicherweise leere oder Nullwerte.

Wenn eine Eigenschaft optional ist oder einen leeren oder Nullwert hat, sollten Sie die Eigenschaft aus dem JSON löschen, es sei denn, es gibt einen starken semantischen Grund für ihre Existenz.

{
  "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
}

Weiterführende Literatur
Google Style Guide - Leere oder Null-Eigenschaftswerte
Sollten Nullwerte in JSON-Antworten von einer REST API? enthalten sein

33
Robert Harvey