retrofit2-kotlinx-serialization-converter

by JakeWharton

A Retrofit 2 Converter.Factory for Kotlin serialization.

570 Stars 36 Forks Last release: Not found Apache License 2.0 50 Commits 9 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.