Cole models C# feitos com class, record ou struct e receba um JSON de exemplo que segue as regras do System.Text.Json e do Newtonsoft.Json. Escolha entre a naming policy camelCase, que o ASP.NET Core usa por padrão, e os nomes de propriedade como foram escritos; nomes definidos com [JsonPropertyName] ou [JsonProperty] sempre têm prioridade.
Use para entregar um exemplo ao frontend ou a um parceiro externo a partir dos models de request/response de uma Web API, para preencher exemplos do Swagger (Swashbuckle) ou para preparar bodies para testes de integração com HttpClient.
using, namespace, construtores e métodos podem ficar.Política de nomes: camelCase (padrão do ASP.NET Core) para projetos Web API padrão, ou Nomes das propriedades como estão se você define PropertyNamingPolicy = null ou usa os padrões do Newtonsoft.Tipo raiz em Automático, o primeiro tipo que nenhum outro model referencia vira a raiz; troque pela lista se precisar..http ou o body de request de um teste xUnit. As opções escolhidas ficam salvas na URL.public class InventoryItem
{
public Guid Id { get; set; }
public string SKU { get; set; } = "";
[JsonPropertyName("stock_qty")]
public int StockQuantity { get; set; }
public StockState State { get; set; } = StockState.InStock;
public DateTimeOffset UpdatedAt { get; set; }
public List<string> Barcodes { get; set; } = new();
[JsonIgnore]
public string WarehouseNote { get; set; } = "";
private int _version;
}
public enum StockState { InStock, LowStock, OutOfStock }{
"id": "00000000-0000-0000-0000-000000000000",
"sku": "",
"stock_qty": 0,
"state": 0,
"updatedAt": "1970-01-01T00:00:00+00:00",
"barcodes": [
""
]
}Com a policy camelCase, um nome todo em maiúsculas como SKU vira sku, igual ao JsonNamingPolicy.CamelCase do System.Text.Json, enquanto [JsonPropertyName("stock_qty")] mantém o nome independente da policy. WarehouseNote ([JsonIgnore]) e o campo private _version ficam de fora. O enum State não tem converter de string, então aparece 0, o valor numérico do seu inicializador StockState.InStock.
[JsonPropertyName] do System.Text.Json, [JsonProperty] do Newtonsoft e [DataMember(Name = ...)].public, mais membros não públicos marcados com [JsonInclude]. static, const, [JsonIgnore] e [IgnoreDataMember] são excluídos; ignores condicionais como Condition = WhenWritingNull são mantidos.record Customer(long Id, string Name)) e targets [property: JsonPropertyName(...)] são suportados.=> ...) são incluídas, como o System.Text.Json as serializaria.= 10). Com [JsonConverter(typeof(JsonStringEnumConverter))] (ou o StringEnumConverter do Newtonsoft) no enum ou na propriedade, ou com [JsonStringEnumMemberName] / [EnumMember(Value = ...)] nos membros, é usada a string do nome.DateTime → 1970-01-01T00:00:00, DateTimeOffset → 1970-01-01T00:00:00+00:00, DateOnly → 1970-01-01, TimeOnly/TimeSpan → 00:00:00, Guid → GUID todo zerado.int?/Nullable<T> usam o tipo interno, List<T>/IEnumerable<T>/arrays ganham um elemento, Dictionary<int, V> usa a chave "0", e object, JsonElement e JObject viram null.= 1.5, = "KRW") são usados como valores de exemplo.DTOs que misturam [JsonPropertyName] com a nomenclatura padrão fazem os exemplos gerados pelo Swagger UI serem fáceis de interpretar errado. Use esta saída num ISchemaFilter ou num comentário XML <example> para que a documentação e a resposta tenham as mesmas chaves.
Alterne a Política de nomes no mesmo model para ver de antemão como o case das chaves muda depois da migração.
Quando client e servidor mantêm cópias separadas de um model, gere o JSON de cada lado e compare para achar rapidamente diferenças nos nomes das chaves.
JsonStringEnumConverter registrado globalmente com AddJsonOptions no Program.cs não aparece no código do model, então os enums continuam saindo como números. Para ver os nomes, adicione [JsonConverter(typeof(JsonStringEnumConverter))] na declaração do enum antes de colar.string? recebem um exemplo do tipo, não null.[JsonConverter] customizados que não sejam o converter de string de enum, o DefaultIgnoreCondition do JsonSerializerOptions e policies snake_case (JsonNamingPolicy.SnakeCaseLower) não são aplicados.[JsonPolymorphic]/[JsonDerivedType] não é suportado; só o tipo base declarado é gerado.Política de nomes?O ASP.NET Core Web API usa JsonSerializerDefaults.Web, que é camelCase. Uma console app que chama JsonSerializer.Serialize sem opções, ou o Newtonsoft.Json com as configurações padrão, mantém os nomes das propriedades, então nesses casos escolha Nomes das propriedades como estão.
public string FullName => ...?Tanto o System.Text.Json quanto o Newtonsoft.Json serializam propriedades públicas com getter, então propriedades calculadas também acabam nas respostas. Adicione [JsonIgnore] se não quiser que elas sejam exportadas.
[JsonPropertyName] no parâmetro posicional de um record não renomeia a chave em runtime.Sem target, o compilador aplica o atributo só ao parâmetro do construtor. Esta ferramenta reconhece as duas formas, mas para renomear a propriedade serializada com segurança escreva [property: JsonPropertyName("...")].
Z nos valores DateTime?Um DateTime com DateTimeKind.Unspecified é serializado sem offset. Se você precisa de um offset UTC explícito, o DateTimeOffset gera a forma +00:00.