feat: adding JSON overview and Json configuration docs #3102
Conversation
|
|
||
| * Serialize Kotlin objects to JSON strings using the [`encodeToString()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/encode-to-string.html) function. | ||
| * Deserialize JSON strings back to Kotlin objects with the [`decodeFromString()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/decode-from-string.html) function. | ||
| * Work directly with the [`JsonElement`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/) when handling complex JSON structures using the [`encodeToJsonElement()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/encode-to-json-element.html) and the [`decodeFromJsonElement()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/decode-from-json-element.html) functions. |
There was a problem hiding this comment.
I see we can nicely add encodeToStream/decodeFromStream to the list here. IMO it's OK to add a separate page for them + Okio integration
There was a problem hiding this comment.
yes it definitely fits neatly here 👍
- Use JVM streams with the
encodeToStream().decodeFromStream(), and.decodeToSequence()functions to work with JSON directly from input and output streams.
There was a problem hiding this comment.
Great. Oh, and Okio's encodeToSink/decodeFromSource can also go there
sandwwraith
left a comment
sandwwraith
left a comment
There was a problem hiding this comment.
I didn't look through io-sources.md since it is not finished
sandwwraith
left a comment
sandwwraith
left a comment
There was a problem hiding this comment.
See unresolved conversations
| ``` | ||
| {kotlin-runnable="true"} | ||
|
|
||
| In addition to using the default configuration, you can [customize the `Json` instance](serialization-json-configuration.md) for specific different use cases, |
There was a problem hiding this comment.
| In addition to using the default configuration, you can [customize the `Json` instance](serialization-json-configuration.md) for specific different use cases, | |
| In addition to using the default configuration, you can [customize the `Json` instance](serialization-json-configuration.md) for special use cases, |
There was a problem hiding this comment.
I like the idea of removing different from here 🤔 , but I prefer specific is better than "special" ("special" would indicate something unexpected imho, unlike "specific", which signals that customization is intended for known, intentional scenarios)
There was a problem hiding this comment.
My view is that in general you want to create your own (stored) instance, and have to in many cases. As such calling the cases "special" (or "specific different"???) misleads as the customization being the generic solution, and the default instance a special case shortcut.
This is the fifth part of the Kotlin Serialization rewrite task.
Related Youtrack ticket: KT-81979