JSON para Classe C#

O que é a Conversão de JSON para C#?

A conversão de JSON para C# é o processo de gerar definições de classes C# fortemente tipadas a partir de dados JSON. Quando uma aplicação .NET recebe JSON de uma API, arquivo de configuração ou fila de mensagens, ela precisa de classes C# para desserializar esses dados em objetos. Escrever essas classes manualmente é tedioso e sujeito a erros, especialmente quando o JSON contém objetos aninhados, arrays e tipos mistos.

Um gerador de classes C# a partir de JSON inspeciona a estrutura e os valores do seu JSON, infere o tipo C# adequado para cada campo e produz definições de classes com acessores de propriedade e atributos de serialização. A saída segue as convenções de nomenclatura do .NET: nomes de propriedades em PascalCase, atributos JsonPropertyName para mapeamento com as chaves JSON originais em camelCase ou snake_case, e uso correto de List'<'T'>' para arrays.

Essa conversão é especialmente comum em APIs web ASP.NET Core, Azure Functions e qualquer serviço .NET que consuma dados JSON externos. Em vez de usar dynamic ou Dictionary'<'string, object'>', classes tipadas oferecem segurança em tempo de compilação, suporte ao IntelliSense e proteção contra erros de digitação em nomes de campos que só apareceriam em tempo de execução. Cole seu JSON nesta ferramenta e obtenha classes C# prontas para uso instantaneamente.

Por que usar um Gerador de JSON para C#?

Escrever classes de modelo C# manualmente a partir de exemplos JSON consome tempo e introduz erros humanos. Um gerador cuida das partes repetitivas para que você possa se concentrar na lógica de negócio.

Casos de Uso de JSON para C#

Referência de Mapeamento de Tipos JSON para C#

Cada tipo de valor JSON é mapeado para um tipo C# específico. O gerador analisa os valores reais para escolher o tipo mais preciso. Por exemplo, um número JSON sem ponto decimal se torna int, enquanto 3.14 se torna double. Valores nulos produzem object? (tipo de referência anulável), pois o tipo real não pode ser inferido apenas a partir de null.

System.Text.Json vs Newtonsoft.Json

O .NET possui duas grandes bibliotecas de serialização JSON. As classes geradas por esta ferramenta usam atributos do System.Text.Json (JsonPropertyName), que é a opção integrada desde o .NET Core 3.0. Se o seu projeto usa Newtonsoft.Json, você pode trocar os atributos.

Exemplos de Código

Estes exemplos mostram como definir e usar classes C# geradas a partir de JSON, utilizando as duas principais bibliotecas de serialização, além de como automatizar a geração pela linha de comando.

using System.Text.Json;

var json = """{"id": 1, "name": "Alice", "active": true}""";
var user = JsonSerializer.Deserialize<User>(json);
Console.WriteLine(user.Name); // → "Alice"

public class User
{
    [JsonPropertyName("id")]
    public int Id { get; set; }

    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("active")]
    public bool Active { get; set; }
}

using Newtonsoft.Json;

var json = @"{""id"": 1, ""name"": ""Alice"", ""scores"": [98, 85]}";
var user = JsonConvert.DeserializeObject<User>(json);
Console.WriteLine(user.Scores[0]); // → 98

public class User
{
    [JsonProperty("id")]
    public int Id { get; set; }

    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonProperty("scores")]
    public List<int> Scores { get; set; }
}

// Install: npm install -g quicktype
// Generate C# classes from JSON:
// quicktype --lang csharp --src data.json --out Models.cs

// From stdin:
// echo '{"id": 1, "name": "Alice"}' | quicktype --lang csharp

// Output:
// public class Root
// {
//     [JsonPropertyName("id")]
//     public int Id { get; set; }
//
//     [JsonPropertyName("name")]
//     public string Name { get; set; }
// }

import json

def json_to_csharp(data: dict, class_name: str = "Root") -> str:
    lines = [f"public class {class_name}", "{"]
    type_map = {str: "string", int: "int", float: "double", bool: "bool"}

    for key, value in data.items():
        cs_type = type_map.get(type(value), "object")
        prop = key[0].upper() + key[1:]  # PascalCase
        lines.append(f'    [JsonPropertyName("{key}")]')
        lines.append(f'    public {cs_type} {prop} {{ get; set; }}')
        lines.append('')
    lines.append("}")
    return "\n".join(lines)

data = json.loads('{"id": 1, "name": "Alice", "active": true}')
print(json_to_csharp(data))

Perguntas Frequentes