JSON a Clase C#

¿Qué es la conversión de JSON a C#?

La conversión de JSON a C# es el proceso de generar definiciones de clases C# fuertemente tipadas a partir de datos JSON. Cuando una aplicación .NET recibe JSON de una API, un archivo de configuración o una cola de mensajes, necesita clases C# para deserializar esos datos en objetos. Escribir estas clases a mano es tedioso y propenso a errores, especialmente cuando el JSON contiene objetos anidados, arrays y tipos mixtos.

Un generador de clases C# a partir de JSON inspecciona la estructura y los valores de tu JSON, infiere el tipo C# adecuado para cada campo y produce definiciones de clases con accesores de propiedades y atributos de serialización. La salida sigue las convenciones de nomenclatura de .NET: nombres de propiedades en PascalCase, atributos JsonPropertyName para mapear a las claves JSON originales en camelCase o snake_case, y uso correcto de List'<'T'>' para arrays.

Esta conversión es especialmente habitual en APIs web de ASP.NET Core, Azure Functions y cualquier servicio .NET que consuma datos JSON externos. En lugar de usar dynamic o Dictionary'<'string, object'>', las clases tipadas ofrecen seguridad en tiempo de compilación, soporte de IntelliSense y protección frente a errores tipográficos en nombres de campo que de otro modo solo aparecerían en tiempo de ejecución. Pega tu JSON en esta herramienta y obtén clases C# listas para usar al instante.

¿Por qué usar un generador de JSON a C#?

Escribir clases de modelo C# a mano a partir de ejemplos JSON lleva tiempo y puede introducir errores humanos. Un generador se encarga de las partes repetitivas para que puedas centrarte en la lógica de negocio.

Casos de uso de JSON a C#

Referencia de mapeo de tipos JSON a C#

Cada tipo de valor JSON se mapea a un tipo C# específico. El generador analiza los valores reales para elegir el tipo más preciso. Por ejemplo, un número JSON sin punto decimal se convierte en int, mientras que 3.14 se convierte en double. Los valores null producen object? (tipo de referencia nullable), ya que el tipo real no puede inferirse a partir de null por sí solo.

System.Text.Json vs Newtonsoft.Json

.NET cuenta con dos bibliotecas principales de serialización JSON. Las clases generadas por esta herramienta usan atributos de System.Text.Json (JsonPropertyName), que es la opción integrada desde .NET Core 3.0. Si tu proyecto usa Newtonsoft.Json, puedes sustituir los atributos.

Ejemplos de código

Estos ejemplos muestran cómo definir y usar clases C# generadas a partir de JSON, con ambas bibliotecas principales de serialización, y cómo automatizar la generación desde la línea de comandos.

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))

Preguntas frecuentes