Need help with retrofit2-kotlinx-serialization-converter?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

JakeWharton
647 Stars 40 Forks Apache License 2.0 50 Commits 1 Opened issues

Description

A Retrofit 2 Converter.Factory for Kotlin serialization.

Services available

!
?

Need anything else?

Contributors list

# 209
Java
Kotlin
Android
kotlin-...
38 commits
# 66,855
Kotlin
Dart
Google
api-res...
2 commits
# 56,346
Kotlin
github-...
Java
Android
1 commit
# 189,589
Shell
kotlin-...
kotlin-...
kotlin-...
1 commit
# 552,947
Kotlin
Shell
1 commit
# 499,158
Shell
Android
CSS
TeX
1 commit

Kotlin Serialization Converter

A Retrofit 2

Converter.Factory
for Kotlin serialization.

Usage

Add a converter factory when building your

Retrofit
instance using the
asConverterFactory
extension function:
val contentType = "application/json".toMediaType()
val retrofit = Retrofit.Builder()
    .baseUrl("https://example.com/")
    .addConverterFactory(Json.asConverterFactory(contentType))
    .build()

Response body types (e.g.,

Call
) and
@Body
types (e.g.,
@Body user: User
) will now use the supplied serializer.

Because Kotlin serialization is so flexible in the types it supports, these converters assume that they can handle all types. If you are mixing this converter with another, you must add this instance last to allow the other converters a chance to see their types.

Download

Download the latest JAR or grab via Gradle:

kotlin
implementation("com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:0.8.0")

or Maven:

xml

  com.jakewharton.retrofit
  retrofit2-kotlinx-serialization-converter
  0.8.0

Snapshots of the development version are available in Sonatype's

snapshots
repository.

License

Copyright 2018 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.