JSON in C#-class umwandeln!

Gib JSON ein, um C#-class-Code inklusive verschachtelter Objekte zu erzeugen! Unterstützt System.Text.Json [JsonPropertyName], .NET, ASP.NET Core.
JSON
Ergebnis
 

JSON in C#-class umwandeln!

Wandle JSON in C#-Klassen für System.Text.Json um. Property-Namen werden in PascalCase umgesetzt, und jede Property trägt ein [JsonPropertyName]-Attribut, damit sie exakt an den ursprünglichen Key gebunden wird.

Das spart Abtipparbeit bei Request- und Response-Modellen in ASP.NET Core, bei Typen für Aufrufe externer APIs mit HttpClient.GetFromJsonAsync<T>() und bei Datenklassen in Unity- oder MAUI-Apps.

So funktioniert es

  1. Füge eine JSON-Antwort oder eine Konfigurationsdatei ein.
  2. Gib in Typname den Namen der Wurzelklasse ein (zum Beispiel PaymentResult).
  3. Leg die erzeugten Klassen in einer .cs-Datei ab und ergänze deinen namespace.
  4. Verwende sie mit JsonSerializer.Deserialize<PaymentResult>(json) oder GetFromJsonAsync<PaymentResult>(url).

Beispiel

Eingabe (JSON)
{
  "paymentId": "pay_8f2k",
  "amount": 15000,
  "currency": "KRW",
  "approved": true,
  "approvedAt": "2024-05-01T12:30:00Z",
  "card": { "issuer": "VISA", "last4": "4242" },
  "metadata": null
}
Ausgabe (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;
}

Jede Property hat [JsonPropertyName], daher passt paymentId ↔ PaymentId unabhängig von Schreibweisenregeln. metadata ist immer nur null, sein Typ ist also unbekannt und es wird zu JsonElement?. String- und Objekt-Properties bekommen die Initialisierer string.Empty / new(), damit der Code ohne Nullable-Warnungen kompiliert.

Unterstützte Funktionen

  • [JsonPropertyName("originalKey")] an jeder Property, zusammen mit using System.Text.Json.Serialization;.
  • Typen: string, int, long für Ganzzahlen über 32 Bit, double für Dezimalzahlen, bool und List<T> für Arrays.
  • Werte mit gemischtem oder unbekanntem Typ werden zu JsonElement, wofür using System.Text.Json; ergänzt wird.
  • Properties, die in manchen Elementen fehlen oder null enthalten, werden nullable (int?, string?).
  • Pflicht-Properties bekommen die Initialisierer = string.Empty; oder = new();, um die Nullable-Referenz-Warnung CS8618 zu vermeiden.
  • Eine Property mit demselben Namen wie ihre Klasse ist in C# nicht erlaubt und bekommt daher das Suffix Value (z. B. RootValue).
  • Ein Array auf oberster Ebene ergibt einen Kommentar // Root: List<RootItem> und die Elementklasse.

Anwendungsfälle

Externe APIs mit HttpClient aufrufen

Wandle eine Beispielantwort einer Zahlungs- oder Sendungsverfolgungs-API um und verwende sie als Typ in await http.GetFromJsonAsync<PaymentResult>(url), statt Felder einzeln aus einem JsonDocument zu ziehen.

Webhook-Payload-Modelle in ASP.NET Core

Erzeuge Klassen aus dem Payload, den ein Drittanbieterdienst an dich sendet, und nimm sie als [FromBody]-Parameter entgegen, damit Model Binding und Validierung wie gewohnt funktionieren.

appsettings und Spieldatendateien

Legst du die Struktur einer JSON-Datendatei, die eine Unity- oder Konsolen-App liest, in Klassen fest, zeigt sich eine geänderte Datendatei sofort als Deserialisierungsfehler.

Hinweise und Einschränkungen

  • Ausgabe für Newtonsoft.Json ([JsonProperty]) wird nicht erzeugt. Nutzt du Json.NET, stelle die Attribute auf [JsonProperty("key")] um.
  • Datums-Strings bleiben string. Bei ISO-8601-Werten genügt es, den Typ auf DateTime oder DateTimeOffset zu ändern, damit System.Text.Json sie parst.
  • Target-typed new() und string? setzen C# 9+ mit aktiviertem Nullable-Kontext voraus (seit .NET 6 Standard).
  • Keine Ausgabe von record oder required. Für unveränderliche Modelle ändere { get; set; } zu { get; init; }.
  • Alle Klassen kommen in einem Block; Dateien und Namespaces teilst du selbst auf.

Häufige Fragen

Warum [JsonPropertyName] ergänzen, auch wenn der Key schon passt?

System.Text.Json unterscheidet standardmäßig Groß- und Kleinschreibung. In Konsolen- oder Worker-Projekten ohne eigene JsonSerializerOptions würde paymentId nicht an PaymentId gebunden; das Attribut wird deshalb immer geschrieben, damit es unabhängig von der Konfiguration funktioniert.

Wie lese ich eine JsonElement?-Property?

Prüfe ValueKind und verwende dann GetString(), GetInt32() oder Deserialize<T>(). Sobald du den echten Typ kennst, ist es sauberer, JsonElement durch ihn zu ersetzen.

Kann ich Property-Namen in camelCase behalten?

Die Ausgabe folgt der PascalCase-Konvention von C#. Der ursprüngliche Key steht in [JsonPropertyName], du kannst Properties also frei umbenennen, solange das Attribut bleibt.

Funktioniert es mit JsonUtility von Unity?

JsonUtility verarbeitet nur öffentliche Felder von [Serializable]-Klassen, keine Properties, und ignoriert [JsonPropertyName]. Kombiniere die Ausgabe in Unity stattdessen mit dem Newtonsoft.Json-Paket oder mit System.Text.Json.