web-dev-qa-db-fra.com

null vs clé manquante dans REST Réponse de l'API

Dites dans mon application, certains utilisateurs nous donnent leur nom de famille et d'autres pas. Dans une réponse API REST, quel corps est préféré:

Avec une valeur "null":

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

Ou juste une clé manquante:

{"firstName": "Bob"}
43
jtmarmon

Pensez à supprimer les valeurs vides ou nulles.

Si une propriété est facultative ou a une valeur vide ou nulle, envisagez de supprimer la propriété du JSON, sauf s'il existe une raison sémantique forte pour son existence.

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

Lectures complémentaires
Google Style Guide - Valeurs de propriété vides ou nulles
Les valeurs nulles doivent-elles être incluses dans les réponses JSON d'une API REST?

33
Robert Harvey