JSON en classe C#

À propos de l’outil JSON en classe C#

L’outil JSON en classe C# écrit les classes de modèle C# d’un échantillon JSON ou d’un JSON Schema avec quicktype-core, dans votre navigateur. Le code est placé dans l’espace de noms de votre choix (App par défaut), avec les directives using du sérialiseur : System.Text.Json, avec un attribut [JsonPropertyName] sur chaque propriété, ou Newtonsoft.Json, avec [JsonProperty]. Chaque objet imbriqué devient une classe public partial, ou un record si « Records (C# 9+) » est coché ; celle du premier niveau prend le « Nom de la classe » (Root par défaut). Les propriétés sont en PascalCase et gardent chaque clé d’origine dans leur attribut. Les nombres entiers sont typés long, les décimaux double ou decimal, et les tableaux deviennent des tableaux comme Item[] ou des listes comme List<Item>. Les propriétés absentes de certains éléments d’un tableau sont nullables et ne sont pas écrites quand elles valent null. Une valeur de deux types, par exemple un nombre dans un élément et du texte dans un autre, ajoute une structure d’union et les classes JsonConverter dont elle a besoin. Le JSON peut être collé ou ouvert depuis un fichier .json ou .txt.

Exemple

Une commande avec ses lignes ; note n’apparaît que dans une ligne, elle devient donc 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; }
    }
}

Comment générer des classes C# à partir de JSON

1. 1Collez un échantillon JSON dans « Entrée JSON », ou cliquez sur « Ouvrir un fichier » pour charger un fichier .json ou .txt. Pour un JSON Schema, choisissez « JSON Schema » dans « Source ».
2. 2Choisissez le « Sérialiseur », puis donnez au « Nom de la classe » et à l’« Espace de noms » ceux de votre projet.
3. 3Cliquez sur « Convertir » pour obtenir les classes dans « Sortie C# ».
4. 4Cliquez sur « Copier », ou sur « Télécharger » pour enregistrer le code sous « Model.cs ».

Formats et limites

Entrée

Objet JSON ou tableau d’objets, ou JSON Schema, collé ou ouvert depuis un fichier .json ou .txt

Sortie

Classes ou records C# dans l’espace de noms de votre choix (App par défaut), enregistrés sous Model.cs

Sérialiseur

System.Text.Json : [JsonPropertyName] sur chaque propriété, [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] sur les propriétés optionnelles ; ou Newtonsoft.Json : [JsonProperty], avec NullValueHandling.Ignore sur les propriétés optionnelles

Types

long, double ou decimal, bool, string, et tableaux (T[]) ou listes (List<T>) ; object pour une clé qui vaut null dans tout l’échantillon ; une structure d’union quand une valeur a deux types ; depuis un JSON Schema, aussi des enums et DateTimeOffset

Où votre JSON est traité

Les classes sont générées par du JavaScript qui s’exécute sur votre appareil : le JSON que vous collez ou ouvrez et le C# obtenu ne sont jamais envoyés. La bibliothèque quicktype se charge à votre premier clic sur « Convertir ». Si la page affiche une erreur, notre journal des erreurs en reçoit le texte, débarrassé des fragments cités, des nombres longs et des adresses web ou e-mail, avec le nom de l’outil ainsi que le nom et la version de votre navigateur.

Questions fréquentes

Trucs et astuces

• ✓Collez un tableau de plusieurs éléments pour que les propriétés parfois absentes deviennent nullables.
• ✓Choisissez decimal dans « Nombres décimaux » pour les prix et les montants : double ne peut pas représenter exactement des valeurs comme 0,1.

Outils associés

• JSON en TypeScript
• JSON en struct Go
• JSON en classe Python
• Formateur JSON