O JSON deve incluir valores nulos [fechado]

Estou criando uma API que retorna resultados como JSON. Existe uma prática recomendada atual para saber se devemos incluir chaves no resultado quando o valor é nulo? Por exemplo:

{
    "title":"Foo Bar",
    "author":"Joe Blow",
    "isbn":null
}

ou

{
    "title":"Foo Bar",
    "author":"Joe Blow"
}

Como o segundo é menor, estou inclinado a esse estilo, mas não tenho certeza se existe um estilo preferido ou não. Da perspectiva do cliente, parece que os dois estilos seriam funcionalmente equivalentes. Quaisquer prós ou contras de cada um?

O segundo economizará uma pequena quantidade de largura de banda, mas se essa fosse uma preocupação, você também usaria matrizes indexadas em vez de preencher o JSON com chaves. Claramente, ["Foo Bar","Joe Blow"]é muito mais curto do que o que você tem agora.

Em termos de usabilidade, não acho que faça diferença. Em ambos os casos, if(json.isbn)irá saltar para o else. Geralmente não há necessidade de distinguir entre null(nenhum valor) e undefined(nenhum valor fornecido).

Sou fã de sempre incluir null explicitamente, pois isso tem significado. A omissão de uma propriedade deixa ambiguidade.

Contanto que seu protocolo com o servidor seja acordado, qualquer um dos itens acima pode funcionar, mas se você passar nulos do servidor, acredito que isso torna suas APIs mais flexíveis posteriormente.

Também deve mencionar que a função hasOwnProperty do javascript oferece mais informações.

/* if true object DOES contain the property with *some* value */
if( objectFromJSON.hasOwnProperty( "propertyName" ) )

/* if true object DOES contain the property and it has been set to null */
if( jsonObject.propertyName === null )

/* if true object either DOES NOT contain the property
   OR
   object DOES contain the property and it has been set to undefined */
if( jsonObject.propertyName === undefined )

Em JavaScript, nullsignifica algo muito diferente de undefined.

Sua saída JSON deve refletir o que é usado e necessário para seu aplicativo no contexto específico de uso dos dados JSON.

Definitivamente, você deve incluí-lo se houver necessidade de distinguir entre nulle, undefineduma vez que eles têm dois significados diferentes em Javascript. Você pode pensar nullque significa que a propriedade é desconhecida ou sem sentido e undefinedque significa que a propriedade não existe.

Por outro lado, se não há necessidade de ninguém fazer essa distinção, vá em frente e deixe-a de fora.

Acho que não faz diferença quando você usa o JSON como um dado por trás da experiência do usuário.

A diferença aparece nos arquivos JSON-config, quando um usuário deve editar algo manualmente. Ao usar o primeiro exemplo, você dá ao usuário algumas dicas sobre a configuração.