Tempel model C# yang dibangun dari class, record atau struct dan dapatkan contoh dokumen JSON yang mengikuti aturan System.Text.Json dan Newtonsoft.Json. Pilih antara naming policy camelCase yang dipakai ASP.NET Core secara default atau nama properti sesuai yang ditulis; nama yang diatur dengan [JsonPropertyName] atau [JsonProperty] selalu diutamakan.
Gunakan untuk memberikan contoh ke frontend atau partner eksternal dari model request/response Web API, mengisi contoh Swagger (Swashbuckle), atau menyiapkan body untuk integration test HttpClient.
using, namespace, constructor, dan method boleh tetap ada.Kebijakan penamaan: camelCase (bawaan ASP.NET Core) untuk proyek Web API standar, atau Nama properti apa adanya jika Anda mengatur PropertyNamingPolicy = null atau mengandalkan default Newtonsoft.Tipe akar di Otomatis, tipe pertama yang tidak direferensikan model lain menjadi root; ubah dari daftar jika perlu..http, atau body request xUnit. Pilihan opsi Anda disimpan di URL.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 }{
"id": "00000000-0000-0000-0000-000000000000",
"sku": "",
"stock_qty": 0,
"state": 0,
"updatedAt": "1970-01-01T00:00:00+00:00",
"barcodes": [
""
]
}Di bawah policy camelCase, nama serba kapital seperti SKU menjadi sku, sesuai dengan JsonNamingPolicy.CamelCase milik System.Text.Json, sedangkan [JsonPropertyName("stock_qty")] mempertahankan namanya apa pun policy-nya. WarehouseNote ([JsonIgnore]) dan field private _version tidak disertakan. Enum State tidak memiliki string converter, jadi ditampilkan sebagai 0, nilai numerik dari initializer-nya StockState.InStock.
[JsonPropertyName] dari System.Text.Json, [JsonProperty] dari Newtonsoft, dan [DataMember(Name = ...)].public yang disertakan, ditambah member non-public yang ditandai [JsonInclude]. static, const, [JsonIgnore] dan [IgnoreDataMember] dikecualikan; ignore bersyarat seperti Condition = WhenWritingNull tetap disertakan.record Customer(long Id, string Name)) dan target [property: JsonPropertyName(...)] didukung.=> ...) disertakan, sebagaimana System.Text.Json akan men-serialize-nya.= 10). Dengan [JsonConverter(typeof(JsonStringEnumConverter))] (atau StringEnumConverter dari Newtonsoft) pada enum atau properti, atau [JsonStringEnumMemberName] / [EnumMember(Value = ...)] pada member, string nama yang dipakai.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 berisi nol semua.int?/Nullable<T> memakai tipe di dalamnya, List<T>/IEnumerable<T>/array mendapat satu elemen, Dictionary<int, V> memakai key "0", dan object, JsonElement serta JObject menjadi null.= 1.5, = "KRW") dipakai sebagai nilai contoh.DTO yang mencampur [JsonPropertyName] dengan penamaan default membuat contoh yang dihasilkan Swagger UI mudah disalahpahami. Gunakan output ini di ISchemaFilter atau komentar XML <example> agar dokumentasi dan respons memakai key yang sama.
Ganti-ganti Kebijakan penamaan pada model yang sama untuk melihat bagaimana huruf besar-kecil key berubah setelah migrasi.
Ketika client dan server menyimpan salinan model masing-masing, buat JSON dari tiap sisi lalu bandingkan untuk cepat menemukan nama key yang tidak cocok.
JsonStringEnumConverter yang didaftarkan secara global lewat AddJsonOptions di Program.cs tidak terlihat di kode model, jadi enum tetap keluar sebagai angka. Untuk melihat namanya, tambahkan [JsonConverter(typeof(JsonStringEnumConverter))] ke deklarasi enum sebelum menempel.string? mendapat contoh sesuai tipenya, bukan null.[JsonConverter] kustom selain enum string converter, DefaultIgnoreCondition di JsonSerializerOptions, dan policy snake_case (JsonNamingPolicy.SnakeCaseLower) tidak diterapkan.[JsonPolymorphic]/[JsonDerivedType] tidak didukung; hanya base type yang dideklarasikan yang dihasilkan.Kebijakan penamaan?ASP.NET Core Web API memakai JsonSerializerDefaults.Web, yaitu camelCase. Aplikasi console yang memanggil JsonSerializer.Serialize tanpa opsi, atau pengaturan default Newtonsoft.Json, mempertahankan nama properti, jadi pilih Nama properti apa adanya di sana.
public string FullName => ... ikut muncul?System.Text.Json maupun Newtonsoft.Json men-serialize properti public yang punya getter, jadi computed property juga masuk ke respons. Tambahkan [JsonIgnore] jika Anda tidak ingin properti itu diekspor.
[JsonPropertyName] pada parameter positional record tidak mengganti nama key saat runtime.Tanpa target, compiler hanya menerapkan atribut ke parameter constructor. Alat ini mengenali kedua bentuk, tetapi untuk mengganti nama properti yang di-serialize secara andal, tulis [property: JsonPropertyName("...")].
DateTime tidak memiliki Z?DateTime dengan DateTimeKind.Unspecified di-serialize tanpa offset. Jika Anda butuh offset UTC yang eksplisit, DateTimeOffset menghasilkan bentuk +00:00.