Summary: Moved plugin documentation and related assets to plugin folders, fixed links and configured redirects where required. Now these docs are used for both showing docs in Flipper and generating Flipper docs website. Reviewed By: passy Differential Revision: D29465567 fbshipit-source-id: 3ec4240b215b0d5baea5154f64266a9ba7ead3a5
26 lines
925 B
Plaintext
26 lines
925 B
Plaintext
### Gradle Dependencies
|
|
|
|
Ensure that you already have an explicit dependency in your application's
|
|
`build.gradle` including the plugin dependency, e.g.
|
|
|
|
```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
|
|
|
|
Suppose you have a Retrofit service interface `PersonService` which has Protobuf body or return types. At the time you create your implementation, call the plugin with your `baseUrl` and service class:
|
|
|
|
```
|
|
import com.facebook.flipper.plugins.retrofit2protobuf.SendProtobufToFlipperFromRetrofit
|
|
...
|
|
val personService = retrofit.create(PersonService::class.java)
|
|
SendProtobufToFlipperFromRetrofit(baseUrl, PersonService::class.java)
|
|
```
|