Convertissez du JSON en class C# !

Saisissez du JSON pour générer du code class C#, objets imbriqués compris ! Compatible avec System.Text.Json [JsonPropertyName], .NET, ASP.NET Core.
JSON
Résultat
 

Convertissez du JSON en class C# !

Convertit du JSON en classes C# pour System.Text.Json. Les noms de propriétés sont passés en PascalCase, et chaque propriété porte un attribut [JsonPropertyName] pour se lier exactement à la clé d'origine.

Cela évite le travail de copie et de saisie pour les modèles de requête et de réponse ASP.NET Core, les types des appels HttpClient.GetFromJsonAsync<T>() vers des API externes et les classes de données des applications Unity ou MAUI.

Mode d'emploi

  1. Collez une réponse JSON ou un fichier de configuration.
  2. Saisissez le nom de la classe racine dans Nom du type (par exemple PaymentResult).
  3. Placez les classes générées dans un fichier .cs et ajoutez votre namespace.
  4. Utilisez-les avec JsonSerializer.Deserialize<PaymentResult>(json) ou GetFromJsonAsync<PaymentResult>(url).

Exemple

Entrée (JSON)
{
  "paymentId": "pay_8f2k",
  "amount": 15000,
  "currency": "KRW",
  "approved": true,
  "approvedAt": "2024-05-01T12:30:00Z",
  "card": { "issuer": "VISA", "last4": "4242" },
  "metadata": null
}
Sortie (C# · System.Text.Json)
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;

public class PaymentResult
{
    [JsonPropertyName("paymentId")]
    public string PaymentId { get; set; } = string.Empty;

    [JsonPropertyName("amount")]
    public int Amount { get; set; }

    [JsonPropertyName("currency")]
    public string Currency { get; set; } = string.Empty;

    [JsonPropertyName("approved")]
    public bool Approved { get; set; }

    [JsonPropertyName("approvedAt")]
    public string ApprovedAt { get; set; } = string.Empty;

    [JsonPropertyName("card")]
    public Card Card { get; set; } = new();

    [JsonPropertyName("metadata")]
    public JsonElement? Metadata { get; set; }
}

public class Card
{
    [JsonPropertyName("issuer")]
    public string Issuer { get; set; } = string.Empty;

    [JsonPropertyName("last4")]
    public string Last4 { get; set; } = string.Empty;
}

Chaque propriété a son [JsonPropertyName] : paymentId ↔ PaymentId correspondent donc quelles que soient les règles de casse. metadata ne vaut jamais que null, son type est inconnu et il devient JsonElement?. Les propriétés chaîne et objet reçoivent des initialiseurs string.Empty / new() pour que le code compile sans avertissements de nullabilité.

Fonctionnalités prises en charge

  • [JsonPropertyName("originalKey")] sur chaque propriété, avec using System.Text.Json.Serialization;.
  • Types : string, int, long pour les entiers au-delà de 32 bits, double pour les décimaux, bool, et List<T> pour les tableaux.
  • Les valeurs de type mixte ou inconnu deviennent JsonElement, ce qui ajoute using System.Text.Json;.
  • Les propriétés absentes de certains éléments ou contenant null deviennent nullables (int?, string?).
  • Les propriétés obligatoires reçoivent des initialiseurs = string.Empty; ou = new(); pour éviter l'avertissement de référence nullable CS8618.
  • Une propriété portant le même nom que sa classe est interdite en C# : elle reçoit donc un suffixe Value (par exemple RootValue).
  • Un tableau de premier niveau produit un commentaire // Root: List<RootItem> et la classe d'élément.

Cas d'utilisation

Appeler des API externes avec HttpClient

Convertissez un exemple de réponse d'une API de paiement ou de suivi de colis et utilisez-le comme type dans await http.GetFromJsonAsync<PaymentResult>(url), au lieu d'extraire les champs un par un d'un JsonDocument.

Modèles de payload de webhook dans ASP.NET Core

Générez des classes à partir du payload qu'un service tiers vous envoie et acceptez-les comme paramètre [FromBody] : model binding et validation fonctionnent comme d'habitude.

appsettings et fichiers de données de jeu

Figer en classes la structure d'un fichier de données JSON lu par une application Unity ou console fait apparaître tout changement du fichier sous forme d'erreur de désérialisation immédiate.

Remarques et limites

  • Aucune sortie Newtonsoft.Json ([JsonProperty]) n'est générée. Si vous utilisez Json.NET, remplacez les attributs par [JsonProperty("key")].
  • Les chaînes de date restent string. Pour des valeurs ISO 8601, changer le type en DateTime ou DateTimeOffset suffit pour que System.Text.Json les analyse.
  • Le new() à type cible et string? supposent C# 9+ avec le contexte nullable activé (par défaut depuis .NET 6).
  • Pas de sortie record ni required. Pour des modèles immuables, remplacez { get; set; } par { get; init; }.
  • Toutes les classes sortent en un seul bloc ; le découpage en fichiers et les namespaces sont à votre charge.

FAQ

Pourquoi ajouter [JsonPropertyName] même quand la clé correspond déjà ?

System.Text.Json est sensible à la casse par défaut. Dans un projet console ou worker sans JsonSerializerOptions personnalisées, paymentId ne se lierait pas à PaymentId : l'attribut est donc toujours écrit, pour fonctionner quelle que soit la configuration.

Comment lire une propriété JsonElement? ?

Vérifiez ValueKind, puis utilisez GetString(), GetInt32() ou Deserialize<T>(). Une fois le vrai type connu, remplacer JsonElement par celui-ci est l'option la plus propre.

Puis-je garder des noms de propriétés en camelCase ?

La sortie suit la convention PascalCase de C#. La clé d'origine se trouve dans [JsonPropertyName] : vous pouvez renommer librement les propriétés tant que l'attribut reste.

Est-ce compatible avec le JsonUtility de Unity ?

JsonUtility ne gère que les champs publics des classes [Serializable], pas les propriétés, et ignore [JsonPropertyName]. Dans Unity, associez plutôt la sortie au package Newtonsoft.Json ou à System.Text.Json.