JSONからKotlinへ
JSONのサンプルを、kotlinx.serialization用のアノテーション付きKotlinデータクラスに変換します。プロパティ名はcamelCaseになり、キー名が異なる場合は@SerialNameが付きます。ネストされたオブジェクトにはそれぞれ専用のクラスが作られ、オプションフィールドのデフォルト値はnull、型が混在する値はJsonElementになります。APIレスポンスを貼り付け、Json.decodeFromStringでデコードできます。
よくある質問
ネストされたオブジェクトにはどのような名前が付けられますか?
ネストされたオブジェクトはそれぞれ独立したKotlin型になり、それを含むキーをもとにPascalCaseで命名されます。たとえばaddressはAddressになります。配列内のオブジェクトには、配列キーの単数形が使われるため、usersはUserになります。フィールドが完全に同じオブジェクトは、同じ型を共有します。
フィールドがオプションになるのはどのような場合ですか?
配列に複数のオブジェクトがあり、一部のオブジェクトにキーがない場合、そのフィールドはオプションになります。型はnull許容になり、デフォルト値はnullです。すべてのサンプルに存在するキーは必須です。単一のオブジェクトでは比較対象がないため、すべてのキーが必須になります。
null値はどのように扱われますか?
一部のサンプルではnullで、ほかのサンプルでは値が入っているキーは、String?のようなnull許容型になります。常にnullのキーからは実際の型を判断できないため、JsonElement?になります。正確な型を得るには、実際の値を含むサンプルを貼り付けてください。
どの数値型が使われますか?
整数はLongになり、小数を含む数値はDoubleになります。両方の値を持つフィールドはDoubleになります。
有効な名前ではないキーはどうなりますか?
プロパティ名はcamelCaseに変換され、元のキー名と異なる場合は@SerialNameが付きます。objectのようなKotlinのキーワードはバッククォートで囲まれます。
JSONはアップロードまたは保存されますか?
JSONはこのリクエストのコード生成にのみ使用するためサーバーに送信され、保存されません。ジェネレーターが読み取るのはサンプルの構造と値の型だけなので、貼り付ける前に、機密性の高い値を同じ型のプレースホルダーに置き換えることができます。