Collez une data class Kotlin existante et voyez à quoi elle ressemble une fois sérialisée, sous forme de document JSON d'exemple. Les classes imbriquées, les propriétés List/Map et les enums sont suivis et remplis, et les annotations de renommage comme @SerialName sont appliquées aux clés.
À utiliser quand un serveur et une application partagent des modèles et que vous devez confirmer quel JSON une classe envoie et reçoit réellement, ou quand une doc d'API ou un serveur de mock a besoin d'un exemple de corps de requête.
import/package et les fonctions membres peuvent rester ; elles sont ignorées.Type racine sur Automatique dans la plupart des cas : la première classe qu'aucune autre ne référence devient la racine. Vous pouvez aussi choisir une classe précise dans la liste.Money d'un autre fichier) sortent en null, et leurs noms sont listés à côté des options. Collez aussi ces classes et elles seront remplies.@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"
}authorName est émis sous la forme author_name à cause de @SerialName, et la valeur par défaut PostStatus.DRAFT se résout en "draft" via le @SerialName propre à l'entrée de l'enum. cachedHtml est marqué @Transient et donc supprimé. Une propriété nullable valant null par défaut, comme publishedAt, reçoit quand même un exemple typé (Instant → horodatage ISO) plutôt que null.
@SerialName de kotlinx.serialization, @JsonProperty de Jackson, @SerializedName de Gson et @Json(name = ...) de Moshi.@Transient ou @JsonIgnore, les propriétés private, les propriétés déléguées comme by lazy, les propriétés calculées avec getter seul, les valeurs const et les membres de companion object.Status.PAID devient la valeur JSON de cette entrée.@SerialName au niveau de l'entrée.LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, Instant/OffsetDateTime → chaîne ISO terminée par Z, Duration → PT0S ; UUID reçoit une valeur bien formée.List, Set et Array reçoivent un élément d'exemple ; une map à type de clé numérique comme Map<Int, V> utilise "0" comme clé.null ou un tableau vide au lieu de se développer à l'infini.Collez un DTO de réponse et vous avez le squelette JSON pour un example OpenAPI ou un README. Les champs renommés via @SerialName apparaissent sous le nom que le sérialiseur écrira réellement.
Construisez le corps pour MockWebServer ou une fixture JSON locale à partir du modèle même que renvoie votre interface Retrofit. Remplacez les valeurs génériques ("", 0) par des données réalistes : la structure correspond toujours au modèle.
Montrez à l'équipe serveur exactement ce qu'envoie l'application, ou comparez une spec reçue à votre modèle Kotlin pour repérer les écarts de noms de clés avant qu'ils ne deviennent des erreurs à l'exécution.
"", 0, false), pas des données réalistes ; remplacez-les avant de publier une doc.String?) reçoivent aussi un exemple typé plutôt que null : indiquez séparément quels champs peuvent réellement valoir null.@JsonNaming de Jackson ou JsonNamingStrategy de kotlinx ne sont pas appliquées ; les propriétés sans annotation gardent leur nom Kotlin comme clé.type) et les KSerializer personnalisés ne sont pas reflétés.emptyList() ou listOf(...), ne sont pas évaluées ; la valeur vient alors du type déclaré.@Transient manque dans la sortie. Est-ce normal ?Oui. @Transient de kotlinx.serialization et @JsonIgnore de Jackson excluent un champ de la sérialisation : l'exemple l'omet donc aussi. Un private val déclaré dans le corps de la classe est laissé de côté pour la même raison.
La syntaxe des classes est la même, ils sont donc bien analysés. Les renommages via @SerializedName("...") de Gson et @Json(name = "...") de Moshi sont reconnus.
= null : pourquoi le champ a-t-il une valeur ?Le but est de montrer la forme de chaque champ : une valeur par défaut null est donc ignorée au profit d'un exemple typé. Vous voyez ainsi, par exemple, sous quel format de chaîne transite un Instant?.
Collez-les à la suite dans la même zone de saisie. Tout type encore manquant est nommé à côté des options, ce qui vous indique quoi ajouter.