একটি বিদ্যমান Kotlin data class পেস্ট করুন এবং serialize হওয়ার পর সেটি কেমন দেখায় তা একটি নমুনা JSON ডকুমেন্ট হিসেবে দেখুন। Nested ক্লাস, List/Map প্রপার্টি আর enum অনুসরণ করে পূরণ করা হয়, আর @SerialName-এর মতো নাম বদলানোর annotation key-তে প্রয়োগ হয়।
সার্ভার আর অ্যাপ মডেল শেয়ার করলে কোনো ক্লাস আসলে কোন JSON পাঠায় ও গ্রহণ করে তা নিশ্চিত করতে, অথবা API ডকুমেন্টেশন বা mock সার্ভারের জন্য request body-র নমুনা দরকার হলে এটি ব্যবহার করুন।
import/package লাইন আর member ফাংশন রেখে দিলেও চলে; সেগুলো এড়িয়ে যাওয়া হয়।রুট টাইপ স্বয়ংক্রিয়-এ রাখুন: অন্য কোনো ক্লাস reference করে না এমন প্রথম ক্লাস রুট হয়। তালিকা থেকে নির্দিষ্ট ক্লাসও বেছে নিতে পারেন।Money ক্লাস) null হিসেবে আসে, আর সেগুলোর নাম অপশনের পাশে তালিকা করা হয়। সেই ক্লাসগুলোও পেস্ট করলে সেগুলো পূরণ হবে।@Serializable
data class Article(
val id: Long,
val title: String,
@SerialName("author_name") val authorName: String,
val status: PostStatus = PostStatus.DRAFT,
val tags: List<String> = emptyList(),
val publishedAt: Instant? = null,
@Transient val cachedHtml: String = "",
)
@Serializable
enum class PostStatus {
@SerialName("draft") DRAFT,
@SerialName("published") PUBLISHED,
}{
"id": 0,
"title": "",
"author_name": "",
"status": "draft",
"tags": [
""
],
"publishedAt": "1970-01-01T00:00:00Z"
}@SerialName-এর কারণে authorName বের হয় author_name হিসেবে, আর ডিফল্ট PostStatus.DRAFT enum entry-র নিজস্ব @SerialName-এর মাধ্যমে "draft"-এ resolve হয়। cachedHtml-এ @Transient দেওয়া, তাই বাদ পড়ে। publishedAt-এর মতো null ডিফল্টের nullable প্রপার্টিও null না হয়ে টাইপড নমুনা পায় (Instant → ISO timestamp)।
@SerialName, Jackson-এর @JsonProperty, Gson-এর @SerializedName আর Moshi-র @Json(name = ...)।@Transient বা @JsonIgnore দেওয়া প্রপার্টি, private প্রপার্টি, by lazy-এর মতো delegated প্রপার্টি, শুধু getter-এর computed প্রপার্টি, const ভ্যালু আর companion object-এর member।Status.PAID-এর মতো default সেই entry-র JSON ভ্যালু হয়।@SerialName মেনে।LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → Z দিয়ে শেষ হওয়া ISO স্ট্রিং, Duration → PT0S; UUID সঠিক ফরম্যাটের ভ্যালু পায়।List, Set আর Array একটি নমুনা element পায়; Map<Int, V>-এর মতো সংখ্যার key type-এর map key হিসেবে "0" ব্যবহার করে।null বা ফাঁকা array দিয়ে কেটে দেওয়া হয়।একটি response DTO পেস্ট করলেই OpenAPI example বা README-এর জন্য JSON কাঠামো পেয়ে যান। @SerialName দিয়ে নাম বদলানো ফিল্ড ঠিক সেই নামেই দেখায় যে নামে serializer আসলে লিখবে।
আপনার Retrofit interface যে মডেল ফেরত দেয় ঠিক সেটি থেকেই MockWebServer বা লোকাল JSON fixture-এর body তৈরি করুন। Placeholder ভ্যালু ("", 0) বাস্তবসম্মত ডেটা দিয়ে বদলালেও গঠন মডেলের সাথে মেলে।
অ্যাপ ঠিক কী পাঠায় তা সার্ভার টিমকে দেখান, অথবা পাওয়া spec-কে আপনার Kotlin মডেলের সাথে তুলনা করে key-এর নামের অমিল runtime error হওয়ার আগেই ধরুন।
"", 0, false), বাস্তবসম্মত ডেটা নয়; ডকুমেন্টেশন প্রকাশের আগে বদলে নিন।String?)-ও null না হয়ে টাইপড নমুনা পায়, তাই কোন ফিল্ড আসলে null হতে পারে তা আলাদাভাবে চিহ্নিত করুন।@JsonNaming বা kotlinx-এর JsonNamingStrategy-এর মতো গ্লোবাল নামকরণের নিয়ম প্রয়োগ হয় না; annotation ছাড়া প্রপার্টি তার Kotlin নামকেই key হিসেবে রাখে।type discriminator) আর কাস্টম KSerializer প্রতিফলিত হয় না।emptyList() বা listOf(...)-এর মতো ফাংশন কল দিয়ে তৈরি default মূল্যায়ন করা হয় না; এর বদলে ভ্যালু আসে ডিক্লেয়ার করা type থেকে।@Transient প্রপার্টি নেই। এটা কি প্রত্যাশিত?হ্যাঁ। kotlinx.serialization-এর @Transient আর Jackson-এর @JsonIgnore একটি ফিল্ডকে serialization থেকে বাইরে রাখে, তাই নমুনাতেও এটি বাদ পড়ে। ক্লাসের body-তে ডিক্লেয়ার করা private val-ও একই কারণে বাদ যায়।
ক্লাসের syntax একই, তাই ঠিকঠাক parse হয়। Gson-এর @SerializedName("...") আর Moshi-র @Json(name = "...") দিয়ে বদলানো নাম চেনা হয়।
= null ডিক্লেয়ার করেছি, তবুও ফিল্ডে ভ্যালু কেন?উদ্দেশ্য হলো প্রতিটি ফিল্ডের আকৃতি দেখানো, তাই null default উপেক্ষা করে টাইপড নমুনা ব্যবহার করা হয়। এতে দেখা যায়, যেমন, একটি Instant? কোন স্ট্রিং ফরম্যাটে আদান-প্রদান হয়।
সেগুলো একের পর এক একই ইনপুটে পেস্ট করুন। তখনও যে type অনুপস্থিত, তার নাম অপশনের পাশে দেখানো হয়, যা বলে দেয় আর কী যোগ করতে হবে।