Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.04 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.04 KB
Raw

Thrifty Retrofit converter

License Download

A Retrofit converter implementation using Thrifty for (de)serialization of Apache Thrift requests and responses.

It supports Binary, Compact and Json Thrift protocols. It supports Thrifty models generated in both Java and Kotlin.

Usage

Add the library as a dependency to your build.gradle to automatically download it from jcenter.

compile 'co.infinum:retrofit-converter-thrifty:2.0.0'

... and add the converter factory when you create the Retrofit object.

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://example.com/api/")
    .addConverterFactory(ThriftyConverterFactory.create(ProtocolType.COMPACT))
    .build();

We also maintain a changelog.

Generating new files with thrifty compiler

In case source files need to be generated from .thrift files using a different version of the thrifty compiler, use these commands:

java -jar thrifty-compiler-2.0.1-all.jar --out=retrofit-converter-thrifty/src/test/java/ --lang=java retrofit-converter-thrifty/src/test/resources/phone.thrift
java -jar thrifty-compiler-2.0.1-all.jar --out=retrofit-converter-thrifty/src/test/java/ --lang=kotlin --kt-file-per-type retrofit-converter-thrifty/src/test/resources/phone.thrift

Deploying a new version

To deploy a new version to bintray, use deploy.sh:

./deploy.sh <bintray username> <bintray api key> <artifact version> [optional tag message]

Contributing

Feedback and code contributions are very much welcome. Just make a pull request with a short description of your changes. By making contributions to this project you give permission for your code to be used under the same license.