JSON を System.Text.Json 向けの C# クラスに変換します。プロパティ名は PascalCase にし、すべてのプロパティに [JsonPropertyName] 属性を付けて元のキーと正確にバインドされるようにします。
ASP.NET Core のリクエスト/レスポンスモデル、外部 API を HttpClient.GetFromJsonAsync<T>() で呼ぶときの型、Unity や MAUI アプリのデータクラスを、コピーして打ち込む手間を省けます。
型名 にルートクラスの名前を入力します(例: PaymentResult)。.cs ファイルに入れ、namespace を追加します。JsonSerializer.Deserialize<PaymentResult>(json) や GetFromJsonAsync<PaymentResult>(url) で使います。{
"paymentId": "pay_8f2k",
"amount": 15000,
"currency": "KRW",
"approved": true,
"approvedAt": "2024-05-01T12:30:00Z",
"card": { "issuer": "VISA", "last4": "4242" },
"metadata": null
}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;
}
すべてのプロパティに [JsonPropertyName] があるので、大文字・小文字のルールに関係なく paymentId ↔ PaymentId が一致します。metadata は常に null なので型がわからず、JsonElement? になります。文字列とオブジェクトのプロパティには string.Empty / new() の初期化子が付き、null 許容の警告なしでコンパイルできます。
[JsonPropertyName("originalKey")] を付け、using System.Text.Json.Serialization; を追加します。string、int、32 ビットを超える整数は long、小数は double、bool、配列は List<T>。JsonElement になり、using System.Text.Json; が追加されます。null を含むプロパティは null 許容(int?、string?)になります。= string.Empty; や = new(); の初期化子を付け、null 許容参照型の警告 CS8618 を避けます。Value の接尾辞が付きます(例: RootValue)。// Root: List<RootItem> というコメントと要素のクラスを出力します。決済や配送追跡 API のサンプルレスポンスを変換して await http.GetFromJsonAsync<PaymentResult>(url) の型に使えば、JsonDocument からフィールドを1つずつ取り出す必要がなくなります。
外部サービスが送ってくるペイロードからクラスを生成して [FromBody] パラメーターで受け取れば、モデルバインドと検証がいつもどおり動きます。
Unity やコンソールアプリが読む JSON データファイルの構造をクラスで固定しておけば、データファイルが変わったときにすぐデシリアライズエラーとして表面化します。
[JsonProperty])向けの出力は生成しません。Json.NET を使う場合は、属性を [JsonProperty("key")] に置き換えてください。string のままです。ISO 8601 の値なら、型を DateTime や DateTimeOffset に変えるだけで System.Text.Json が解析してくれます。new() と string? は、null 許容コンテキストが有効な C# 9 以降(.NET 6 以降の既定)を前提にしています。record や required は出力しません。イミュータブルなモデルにするなら、{ get; set; } を { get; init; } に変えてください。[JsonPropertyName] を付けるのはなぜですか?System.Text.Json は既定で大文字・小文字を区別します。独自の JsonSerializerOptions がないコンソールやワーカーのプロジェクトでは paymentId が PaymentId にバインドされないため、設定に関係なく動くよう属性を常に書いています。
JsonElement? のプロパティはどう読めばいいですか?ValueKind を確認してから、GetString()、GetInt32()、Deserialize<T>() を使います。実際の型がわかったら、JsonElement をその型に置き換えるほうがすっきりします。
出力は C# の PascalCase の規約に従います。元のキーは [JsonPropertyName] に入っているので、属性さえ残せばプロパティ名は自由に変えて構いません。
JsonUtility は [Serializable] クラスの public フィールドしか扱えず、プロパティは対象外で、[JsonPropertyName] も無視します。Unity では、出力を Newtonsoft.Json パッケージか System.Text.Json と組み合わせて使ってください。