JSON a clase C#

Acerca de JSON a clase C#

JSON a clase C# escribe las clases de modelo C# de una muestra JSON o de un JSON Schema con quicktype-core, dentro de tu navegador. El código queda en el espacio de nombres que elijas (App por defecto), con las directivas using del serializador: System.Text.Json, con un atributo [JsonPropertyName] en cada propiedad, o Newtonsoft.Json, con [JsonProperty]. Cada objeto anidado se convierte en una clase public partial, o en un record si «Records (C# 9+)» está marcado; la del primer nivel toma el «Nombre de la clase» (Root por defecto). Las propiedades van en PascalCase y conservan cada clave original en su atributo. Los números enteros son long, los decimales double o decimal, y los arrays se convierten en arrays como Item[] o en listas como List<Item>. Las propiedades que faltan en algunos elementos de un array son nullable y no se escriben cuando valen null. Un valor con dos tipos, por ejemplo un número en un elemento y texto en otro, añade una estructura de unión y las clases JsonConverter que necesita. El JSON se puede pegar o abrir desde un archivo .json o .txt.

Ejemplo

Un pedido con sus líneas; note solo aparece en una línea, así que se vuelve nullable.

{"orderId": 1001, "total": 49.90, "paid": true,
 "items": [{"sku": "A1", "qty": 2}, {"sku": "B7", "qty": 1, "note": "gift"}]}

namespace App
{
    using System;
    using System.Collections.Generic;

    using System.Text.Json;
    using System.Text.Json.Serialization;
    using System.Globalization;

    public partial class Root
    {
        [JsonPropertyName("orderId")]
        public long OrderId { get; set; }

        [JsonPropertyName("total")]
        public double Total { get; set; }

        [JsonPropertyName("paid")]
        public bool Paid { get; set; }

        [JsonPropertyName("items")]
        public Item[] Items { get; set; }
    }

    public partial class Item
    {
        [JsonPropertyName("sku")]
        public string Sku { get; set; }

        [JsonPropertyName("qty")]
        public long Qty { get; set; }

        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
        [JsonPropertyName("note")]
        public string? Note { get; set; }
    }
}

Cómo generar clases C# a partir de JSON

1. 1Pega una muestra JSON en «Entrada JSON», o haz clic en «Abrir un archivo» para cargar un archivo .json o .txt. Para un JSON Schema, elige «JSON Schema» en «Origen».
2. 2Elige el «Serializador» y luego pon en «Nombre de la clase» y «Espacio de nombres» los de tu proyecto.
3. 3Haz clic en «Convertir» para obtener las clases en «Salida C#».
4. 4Haz clic en «Copiar», o en «Descargar» para guardar el código como «Model.cs».

Formatos y límites

Entrada

Objeto JSON o array de objetos, o JSON Schema, pegado o abierto desde un archivo .json o .txt

Salida

Clases o records C# en el espacio de nombres que elijas (App por defecto), guardados como Model.cs

Serializador

System.Text.Json: [JsonPropertyName] en cada propiedad, [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] en las opcionales; o Newtonsoft.Json: [JsonProperty], con NullValueHandling.Ignore en las opcionales

Tipos

long, double o decimal, bool, string, y arrays (T[]) o listas (List<T>); object para una clave que vale null en toda la muestra; una estructura de unión cuando un valor tiene dos tipos; desde un JSON Schema, también enums y DateTimeOffset

Dónde se procesa tu JSON

Las clases se generan con JavaScript que se ejecuta en tu propio dispositivo: el JSON que pegas o abres y el C# que obtienes nunca se suben. La biblioteca quicktype se carga la primera vez que pulsas «Convertir». Cuando la página muestra un error, nuestro registro de errores recibe su texto, sin los fragmentos citados, los números largos ni las direcciones web o de correo, junto con el nombre de la herramienta y el nombre y la versión de tu navegador.

Preguntas frecuentes

Consejos y trucos

• ✓Pega un array con varios elementos para que las propiedades que a veces faltan se vuelvan nullable.
• ✓Elige decimal en «Números decimales» para precios e importes: double no puede representar con exactitud valores como 0,1.

Herramientas relacionadas

• JSON a TypeScript
• JSON a struct de Go
• JSON a clase Python
• Formateador JSON