class, record বা struct দিয়ে তৈরি C# মডেল পেস্ট করুন এবং System.Text.Json আর Newtonsoft.Json-এর নিয়ম মেনে একটি উদাহরণ JSON ডকুমেন্ট পান। ASP.NET Core ডিফল্টভাবে যে camelCase naming policy ব্যবহার করে সেটি, অথবা লেখা অনুযায়ী প্রপার্টির নাম, এর মধ্যে বেছে নিন; [JsonPropertyName] বা [JsonProperty] দিয়ে সেট করা নামই সবসময় প্রাধান্য পায়।
Web API-এর request/response মডেল থেকে ফ্রন্টএন্ড বা এক্সটার্নাল পার্টনারকে নমুনা দিতে, Swagger (Swashbuckle)-এর উদাহরণ পূরণ করতে, অথবা HttpClient ইন্টিগ্রেশন টেস্টের body তৈরি করতে এটি ব্যবহার করুন।
using, namespace, constructor আর মেথড রেখে দিলেও চলে।নামকরণ নীতি বেছে নিন: সাধারণ Web API প্রজেক্টের জন্য camelCase (ASP.NET Core ডিফল্ট), অথবা PropertyNamingPolicy = null সেট করে থাকলে বা Newtonsoft-এর ডিফল্টের উপর নির্ভর করলে প্রপার্টির নাম যেমন আছে।রুট টাইপ স্বয়ংক্রিয়-এ থাকলে অন্য কোনো মডেল reference করে না এমন প্রথম type রুট হয়; দরকার হলে তালিকা থেকে বদলান।.http ফাইল বা xUnit request body-তে বসান। আপনার বেছে নেওয়া অপশন 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": [
""
]
}camelCase policy-তে SKU-এর মতো পুরো বড় হাতের নাম হয় sku, System.Text.Json-এর JsonNamingPolicy.CamelCase-এর সাথে মিলিয়ে, অন্যদিকে [JsonPropertyName("stock_qty")] policy যা-ই হোক তার নাম রাখে। WarehouseNote ([JsonIgnore]) আর private ফিল্ড _version বাদ পড়ে। Enum State-এ কোনো string converter নেই, তাই এটি দেখায় 0, যা এর initializer StockState.InStock-এর সংখ্যাগত মান।
[JsonPropertyName], Newtonsoft-এর [JsonProperty], আর [DataMember(Name = ...)]।public প্রপার্টি আর ফিল্ড, সাথে [JsonInclude] চিহ্নিত non-public member অন্তর্ভুক্ত হয়। static, const, [JsonIgnore] আর [IgnoreDataMember] বাদ যায়; Condition = WhenWritingNull-এর মতো শর্তসাপেক্ষ ignore রাখা হয়।record Customer(long Id, string Name)) আর [property: JsonPropertyName(...)] target সাপোর্টেড।=> ...) অন্তর্ভুক্ত হয়, যেমন System.Text.Json সেগুলো serialize করত।= 10-এর মতো স্পষ্ট মানসহ)। Enum বা প্রপার্টিতে [JsonConverter(typeof(JsonStringEnumConverter))] (বা Newtonsoft-এর StringEnumConverter), অথবা member-এ [JsonStringEnumMemberName] / [EnumMember(Value = ...)] থাকলে এর বদলে নামের স্ট্রিং ব্যবহৃত হয়।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।int?/Nullable<T> ভেতরের type ব্যবহার করে, List<T>/IEnumerable<T>/array একটি element পায়, Dictionary<int, V> একটি "0" key ব্যবহার করে, আর object, JsonElement ও JObject হয় null।= 1.5, = "KRW") নমুনা ভ্যালু হিসেবে ব্যবহৃত হয়।[JsonPropertyName] আর ডিফল্ট নামকরণ মেশানো DTO-তে Swagger UI-এর তৈরি উদাহরণ সহজেই ভুল বোঝা যায়। এই আউটপুট একটি ISchemaFilter বা XML <example> কমেন্টে ব্যবহার করুন, যাতে ডকুমেন্টেশন আর response একই key শেয়ার করে।
Migration-এর পরে key-এর casing কীভাবে বদলায় তা আগেই দেখতে একই মডেলে নামকরণ নীতি এদিক-ওদিক বদলান।
ক্লায়েন্ট আর সার্ভার একটি মডেলের আলাদা কপি রাখলে দুই দিক থেকেই JSON তৈরি করে তুলনা করুন, তাহলে key-এর নামের অমিল দ্রুত চোখে পড়ে।
Program.cs-এ AddJsonOptions দিয়ে গ্লোবালি রেজিস্টার করা JsonStringEnumConverter মডেলের কোডে দেখা যায় না, তাই enum তখনও সংখ্যা হিসেবে আসে। নাম দেখতে চাইলে পেস্ট করার আগে enum ডিক্লারেশনে [JsonConverter(typeof(JsonStringEnumConverter))] যোগ করুন।string?-এর মতো nullable reference type null নয়, টাইপড নমুনা পায়।[JsonConverter] অ্যাট্রিবিউট, JsonSerializerOptions-এর DefaultIgnoreCondition, আর snake_case policy (JsonNamingPolicy.SnakeCaseLower) প্রয়োগ হয় না।[JsonPolymorphic]/[JsonDerivedType] দিয়ে polymorphism সাপোর্টেড নয়; শুধু ডিক্লেয়ার করা base type তৈরি হয়।নামকরণ নীতি-এর কোন অপশন কখন ব্যবহার করব?ASP.NET Core Web API JsonSerializerDefaults.Web ব্যবহার করে, যা camelCase। অপশন ছাড়া JsonSerializer.Serialize কল করা কনসোল অ্যাপ, বা Newtonsoft.Json-এর ডিফল্ট সেটিংস প্রপার্টির নাম রেখে দেয়, তাই সেখানে প্রপার্টির নাম যেমন আছে বেছে নিন।
public string FullName => ...-এর মতো computed প্রপার্টি কেন দেখা যায়?System.Text.Json আর Newtonsoft.Json দুটোই getter থাকা public প্রপার্টি serialize করে, তাই computed প্রপার্টিও response-এ চলে যায়। Export করতে না চাইলে [JsonIgnore] যোগ করুন।
[JsonPropertyName] দিলে runtime-এ key-এর নাম বদলায় না।Target না দিলে কম্পাইলার অ্যাট্রিবিউটটি শুধু constructor parameter-এ প্রয়োগ করে। এই টুল দুই রূপই চেনে, কিন্তু serialize হওয়া প্রপার্টির নাম নির্ভরযোগ্যভাবে বদলাতে [property: JsonPropertyName("...")] লিখুন।
DateTime ভ্যালুতে কেন Z নেই?DateTimeKind.Unspecified-যুক্ত DateTime offset ছাড়াই serialize হয়। স্পষ্ট UTC offset দরকার হলে DateTimeOffset +00:00 রূপ তৈরি করে।