JSONをKotlinのdata classに変換!

JSONを入力すると、ネストしたオブジェクトまでKotlinのdata classコードに変換します!kotlinx.serialization @Serializable, @SerialName, Jackson 対応。
JSON
結果
 

JSONをKotlinのdata classに変換!

API レスポンスや設定の JSON を貼り付けると、その構造をそのまま写した Kotlin の data class コードが得られます。ネストしたオブジェクトやオブジェクトの配列はそれぞれ独立したクラスになり、kotlinx.serialization と Jackson のどちらを対象にするかを選べます。

Android アプリや Ktor/Spring のサービスで外部 API をつなぐときに、手で打つ代わりにサンプルレスポンス1つからモデルの骨組みを作りたい場面を想定しています。変換はすべてブラウザー内で行われるので、社内 API のレスポンスを貼り付けてもどこにも送信されません。

使い方

  1. 入力欄に JSON を貼り付けます。削ったものより、実際のレスポンスを丸ごと入れたほうが型推論が正確になります。
  2. 型名 にトップレベルのクラス名を設定します(既定は Root)。例: UserResponse。
  3. シリアライザー で kotlinx.serialization か Jackson を選びます。プロジェクトですでに使っているほうに合わせてください。
  4. 生成されたコードをモデルファイルにコピーします。型名とシリアライザーは URL に残るので、ブックマークすれば同じ設定で開き直せます。

例

入力 (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
出力 (Kotlin · kotlinx.serialization)
import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement

@Serializable
data class Order(
    val orderId: String,
    val paid: Boolean,
    val total: Double,
    val coupon: JsonElement? = null,
    val items: List<Item>
)

@Serializable
data class Item(
    val sku: String,
    val qty: Int,
    @SerialName("gift_wrap") val giftWrap: Boolean? = null
)

items 配列の中のオブジェクトは単数形の Item クラスになり、2つ目の要素にしかない gift_wrap は Boolean? = null になります。coupon は常に null なので型を推論できず、実際の型に置き換えてもらう前提で JsonElement? のままにしています。

対応機能

  • kotlinx.serialization: すべてのクラスに @Serializable、名前が変わったフィールドに @SerialName を付け、必要な import も追加します。
  • Jackson: 名前が変わったフィールドにだけ @JsonProperty を付けます。
  • user_name や home-url のようなキーは camelCase のプロパティ(userName、homeUrl)になり、アノテーションで元のキーに対応付けられます。
  • class や val のような Kotlin のキーワードはバッククォートで囲み、数字で始まるキーには n の接頭辞を付けます。
  • 数値: 整数は Int、32 ビットを超える値は Long、小数が1つでもあればそのフィールドは Double になります。
  • オブジェクトの配列は全要素から1つのクラスにまとめられ、一部の要素にしかないフィールドは ? = null になります。
  • トップレベルが配列やプリミティブのときは typealias を出力します(例: typealias Root = List<RootItem>)。

利用シーン

Retrofit や Ktor クライアントのレスポンスモデル

Postman やブラウザーの DevTools からコピーしたレスポンスを貼り付ければ、Call<Order> や client.get<Order>() にそのまま使えるクラスが得られます。フィールドが数十個あるレスポンスでも、手で写すときのタイプミスや型の間違いを避けられます。

snake_case の API を Kotlin の命名に合わせる

バックエンドが created_at を送ってくる場合、Kotlin 側は createdAt で読み、シリアル名には元のキーが残ります。グローバルな命名戦略に頼らず、対応関係がクラスごとに見える形で残ります。

kotlinx.serialization への移行

Gson や Jackson のモデルを kotlinx.serialization に移すなら、同じ JSON から両方の出力を生成すれば、どのアノテーションが変わるのかが正確にわかります。

注意点と制限

  • 型は貼り付けたサンプルだけから推論します。サンプルのすべての要素にあるフィールドは non-null になるので、API ドキュメントで省略されうるとされているフィールドには自分で ? を付けてください。
  • 2024-01-01T00:00:00Z のような日付の文字列は String のままです。Instant にするには独自のシリアライザーが必要です。
  • kotlinx.serialization は Any をシリアライズできないため、型を推論できない値は kotlinx.serialization では JsonElement、Jackson では Any になります。
  • enum、sealed class、(空リストのような)デフォルト値は生成しません。値の種類が決まっているフィールドは、あとで enum にしておく価値があります。
  • すべてのクラスが1つのブロックで出力されます。package 宣言とファイルの分割は自分で行ってください。

よくある質問

フィールドが単なる String? ではなく String? = null なのはなぜですか?

kotlinx.serialization は、キーがなくプロパティにデフォルト値もないと MissingFieldException を投げます。一部の要素にないフィールドや null を含むフィールドに = null を付けておけば、そのキーのないレスポンスも問題なくデコードできます。

@SerialName を使わずに JSON のキーをそのままプロパティ名にできますか?

このツールは常に camelCase に変換し、名前が異なる場合にだけアノテーションを付けるので、もともと camelCase のキーはアノテーションなしで出力されます。snake_case の名前を残したい場合は、生成後にプロパティ名を変えてアノテーションを外してください。

Jackson を選んだ場合、jackson-module-kotlin は必要ですか?

必要です。生成される data class には引数なしのコンストラクターがないため、Jackson がコンストラクター引数を通して値をバインドするには jackson-module-kotlin の登録が必要です(Spring Boot は依存関係があれば自動で登録します)。

Moshi や Gson のモデルを生成できますか?

シリアライザーの選択肢は kotlinx.serialization と Jackson です。Gson なら Jackson の出力の @JsonProperty を @SerializedName に、Moshi なら @Json(name = ...) に置き換えてください。クラスの構造はそのままで使えます。