Files
flipper/desktop/plugins/public/network/docs/_protobuf-retrofit.mdx
Kevin Strider 1d552972db setup.mdx (setup - Network)
Summary: Restyle of page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: lblasa

Differential Revision: D36348417

fbshipit-source-id: 4e32ff6c2ce25ebcb403f203809dccb5d10ea01d
2022-05-13 03:48:28 -07:00

25 lines
964 B
Plaintext

### Gradle Dependencies
Ensure that you already have an explicit dependency in your application's `build.gradle` including the plugin dependency, as shown in the following example:
```groovy
dependencies {
implementation "com.squareup.retrofit2:retrofit:2.9.0"
implementation "com.squareup.retrofit2:converter-protobuf:2.9.0"
// update version below to match latest Flipper client app
debugImplementation "com.facebook.flipper:flipper-retrofit2-protobuf-plugin:0.84.0"
}
```
### Sending Retrofit Service
If you have a Retrofit service interface `PersonService` which has Protobuf body or return types then at the time you create your implementation, call the plugin with your `baseURL` and service class, as follows:
```
import com.facebook.flipper.plugins.retrofit2protobuf.SendProtobufToFlipperFromRetrofit
...
val personService = retrofit.create(PersonService::class.java)
SendProtobufToFlipperFromRetrofit(baseUrl, PersonService::class.java)
```