I-convert ang mga C# class sa JSON!

I-paste ang C# (class·record) na code at kumuha ng halimbawang JSON! Sinusuportahan ang System.Text.Json [JsonPropertyName], Newtonsoft.Json [JsonProperty]. Magagamit sa API docs at test request body (mock request body).
C#
Resulta
 

I-convert ang mga C# class sa JSON!

I-paste ang mga C# model na binuo mula sa class, record o struct at makakakuha ka ng halimbawang JSON document na sumusunod sa rules ng System.Text.Json at Newtonsoft.Json. Pumili sa pagitan ng camelCase naming policy na default na gamit ng ASP.NET Core at ng mga property name gaya ng pagkakasulat; laging nananaig ang mga pangalang itinakda gamit ang [JsonPropertyName] o [JsonProperty].

Gamitin ito para magbigay ng sample sa frontend o sa external partner mula sa mga Web API request/response model, para punan ang mga Swagger (Swashbuckle) example, o para ihanda ang mga body para sa HttpClient integration test.

Paano gamitin

  1. I-paste ang source ng model. Puwedeng iwan ang using, namespace, mga constructor at method.
  2. Pumili ng Patakaran sa pangalan: camelCase (default ng ASP.NET Core) para sa karaniwang Web API project, o Pangalan ng property gaya ng dati kung nag-set ka ng PropertyNamingPolicy = null o umaasa sa default ng Newtonsoft.
  3. Kapag Awtomatiko ang Root type, ang unang type na hindi nire-reference ng ibang model ang nagiging root; palitan ito mula sa listahan kung kailangan.
  4. Kopyahin ang JSON papunta sa isang Swagger example, .http file o xUnit request body. Naka-save sa URL ang mga napili mong option.

Halimbawa

Input (C#)
public class InventoryItem
{
    public Guid Id { get; set; }
    public string SKU { get; set; } = "";
    [JsonPropertyName("stock_qty")]
    public int StockQuantity { get; set; }
    public StockState State { get; set; } = StockState.InStock;
    public DateTimeOffset UpdatedAt { get; set; }
    public List<string> Barcodes { get; set; } = new();
    [JsonIgnore]
    public string WarehouseNote { get; set; } = "";
    private int _version;
}

public enum StockState { InStock, LowStock, OutOfStock }
Output (JSON · camelCase)
{
  "id": "00000000-0000-0000-0000-000000000000",
  "sku": "",
  "stock_qty": 0,
  "state": 0,
  "updatedAt": "1970-01-01T00:00:00+00:00",
  "barcodes": [
    ""
  ]
}

Sa ilalim ng camelCase policy, nagiging sku ang all-caps na pangalang gaya ng SKU, tugma sa JsonNamingPolicy.CamelCase ng System.Text.Json, habang napapanatili ng [JsonPropertyName("stock_qty")] ang pangalan nito anuman ang policy. Hindi kasama ang WarehouseNote ([JsonIgnore]) at ang private field na _version. Walang string converter ang enum na State, kaya 0 ang ipinapakita nito, ang numeric value ng initializer nitong StockState.InStock.

Mga sinusuportahang feature

  • Mga attribute para magpalit ng pangalan: [JsonPropertyName] ng System.Text.Json, [JsonProperty] ng Newtonsoft, at [DataMember(Name = ...)].
  • Mga public na property at field lang ang kasama, pati ang mga non-public na member na may [JsonInclude]. Hindi kasama ang static, const, [JsonIgnore] at [IgnoreDataMember]; napapanatili ang mga conditional ignore gaya ng Condition = WhenWritingNull.
  • Suportado ang mga positional record (record Customer(long Id, string Name)) at mga target na [property: JsonPropertyName(...)].
  • Kasama ang mga expression-bodied na computed property (=> ...), gaya ng pagse-serialize sa kanila ng System.Text.Json.
  • Isinusulat bilang numero ang mga enum, gaya ng default na ginagawa ng System.Text.Json at Newtonsoft (kasama ang mga explicit na value gaya ng = 10). Kapag may [JsonConverter(typeof(JsonStringEnumConverter))] (o StringEnumConverter ng Newtonsoft) sa enum o sa property, o [JsonStringEnumMemberName] / [EnumMember(Value = ...)] sa mga member, ang name string ang ginagamit.
  • Mga petsa at ID: DateTime → 1970-01-01T00:00:00, DateTimeOffset → 1970-01-01T00:00:00+00:00, DateOnly → 1970-01-01, TimeOnly/TimeSpan → 00:00:00, Guid → GUID na puro zero.
  • Ginagamit ng int?/Nullable<T> ang inner type, may isang element ang List<T>/IEnumerable<T>/array, gumagamit ng key na "0" ang Dictionary<int, V>, at nagiging null ang object, JsonElement at JObject.
  • Ginagamit bilang sample value ang mga literal initializer (= 1.5, = "KRW").

Mga gamit

Pagtugma ng mga Swashbuckle example sa totoong response

Madaling mamali ng basa sa mga example na ginagawa ng Swagger UI kapag hinahalo ng mga DTO ang [JsonPropertyName] at default naming. Gamitin ang output na ito sa isang ISchemaFilter o sa XML comment na <example> para iisang key ang gamit ng docs at ng response.

Paglipat mula Newtonsoft papuntang System.Text.Json

Palipat-lipatin ang Patakaran sa pangalan sa parehong model para ma-preview kung paano magbabago ang casing ng mga key pagkatapos ng migration.

Pag-check ng contract sa pagitan ng Unity/MAUI client at server

Kapag may kanya-kanyang kopya ng model ang client at server, gumawa ng JSON mula sa bawat panig at ikumpara sila para mabilis na makita ang mga hindi tugmang key name.

Mga paalala at limitasyon

  • Hindi nakikita sa model code ang JsonStringEnumConverter na nire-register nang global gamit ang AddJsonOptions sa Program.cs, kaya lumalabas pa ring numero ang mga enum. Para makita ang mga pangalan, idagdag ang [JsonConverter(typeof(JsonStringEnumConverter))] sa enum declaration bago i-paste.
  • Typed na sample ang nakukuha ng mga nullable reference type gaya ng string?, hindi null.
  • Hindi ina-apply ang mga custom na [JsonConverter] attribute maliban sa enum string converter, ang DefaultIgnoreCondition sa JsonSerializerOptions, at mga snake_case policy (JsonNamingPolicy.SnakeCaseLower).
  • Hindi suportado ang polymorphism gamit ang [JsonPolymorphic]/[JsonDerivedType]; ang naka-declare na base type lang ang ginagawa.

Mga madalas itanong

Kailan ko dapat gamitin ang bawat option ng Patakaran sa pangalan?

Gumagamit ang ASP.NET Core Web API ng JsonSerializerDefaults.Web, na camelCase. Pinapanatili naman ang mga property name ng console app na tumatawag ng JsonSerializer.Serialize nang walang options, o ng default na settings ng Newtonsoft.Json, kaya piliin doon ang Pangalan ng property gaya ng dati.

Bakit lumalabas ang computed property gaya ng public string FullName => ...?

Sine-serialize ng System.Text.Json at Newtonsoft.Json ang mga public property na may getter, kaya napupunta rin sa mga response ang mga computed property. Idagdag ang [JsonIgnore] kung ayaw mong ma-export sila.

Hindi pinapalitan ng [JsonPropertyName] sa positional parameter ng record ang key sa runtime.

Kapag walang target, sa constructor parameter lang ina-apply ng compiler ang attribute. Kinikilala ng tool na ito ang parehong anyo, pero para siguradong mapalitan ang pangalan ng serialized property, isulat ang [property: JsonPropertyName("...")].

Bakit walang Z sa mga value ng DateTime?

Sine-serialize nang walang offset ang DateTime na may DateTimeKind.Unspecified. Kung kailangan mo ng explicit na UTC offset, ang DateTimeOffset ang gumagawa ng anyong +00:00.