From 1d552972dbd7f18409ccbf1bc2539af9ee9f8c4c Mon Sep 17 00:00:00 2001 From: Kevin Strider Date: Fri, 13 May 2022 03:48:28 -0700 Subject: [PATCH] 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 --- .../public/network/docs/_protobuf-retrofit.mdx | 7 +++---- desktop/plugins/public/network/docs/setup.mdx | 18 ++++++++---------- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/desktop/plugins/public/network/docs/_protobuf-retrofit.mdx b/desktop/plugins/public/network/docs/_protobuf-retrofit.mdx index 5057987b5..acda950a2 100644 --- a/desktop/plugins/public/network/docs/_protobuf-retrofit.mdx +++ b/desktop/plugins/public/network/docs/_protobuf-retrofit.mdx @@ -1,13 +1,12 @@ ### Gradle Dependencies -Ensure that you already have an explicit dependency in your application's -`build.gradle` including the plugin dependency, e.g. +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" } @@ -15,7 +14,7 @@ dependencies { ### 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: +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 diff --git a/desktop/plugins/public/network/docs/setup.mdx b/desktop/plugins/public/network/docs/setup.mdx index 1a76b0233..c836fa90c 100644 --- a/desktop/plugins/public/network/docs/setup.mdx +++ b/desktop/plugins/public/network/docs/setup.mdx @@ -1,12 +1,14 @@ +import useBaseUrl from '@docusaurus/useBaseUrl'; +import Link from '@docusaurus/Link'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import ProtobufRetrofitSetup from './_protobuf-retrofit.mdx'; -To use the network plugin, you need to add the plugin to your Flipper client instance. +To use the Network plugin, you need to add the plugin to your Flipper client instance. ## Android -The network plugin is shipped as a separate Maven artifact: +The network plugin is shipped as a separate Maven artifact, as follows: ```groovy dependencies { @@ -14,8 +16,7 @@ dependencies { } ``` -Once added to your dependencies, you can instantiate the plugin and add it to -the client: +Once added to your dependencies, you can instantiate the plugin and add it to the client: ```java import com.facebook.flipper.plugins.network.NetworkFlipperPlugin; @@ -32,7 +33,7 @@ client.addPlugin(networkFlipperPlugin); ### OkHttp Integration -If you are using the popular OkHttp library, you can use the Interceptors system to automatically hook into your existing stack. +If you are using the popular OkHttp library, you can use the Interceptors system to automatically hook into your existing stack, as shown in the following snippet: ```java import com.facebook.flipper.plugins.network.FlipperOkhttpInterceptor; @@ -54,7 +55,7 @@ dependencies { } ``` -Then call `SendProtobufToFlipperFromRetrofit` for each service class. +Then call `SendProtobufToFlipperFromRetrofit` for each service class: ```kotlin import com.facebook.flipper.plugins.retrofit2protobuf.SendProtobufToFlipperFromRetrofit @@ -62,7 +63,6 @@ import com.facebook.flipper.plugins.retrofit2protobuf.SendProtobufToFlipperFromR SendProtobufToFlipperFromRetrofit("https://baseurl.com/", MyApiService::class.java) ``` - ## iOS To enable network inspection, add the following pod to your Podfile: @@ -71,7 +71,7 @@ To enable network inspection, add the following pod to your Podfile: pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version ``` -Initialise the plugin in the following way by updating AppDelegate.m: +Initialize the plugin in the following way by updating AppDelegate.m: @@ -80,7 +80,6 @@ Initialise the plugin in the following way by updating AppDelegate.m: #import [[FlipperClient sharedClient] addPlugin: [[FlipperKitNetworkPlugin alloc] initWithNetworkAdapter:[SKIOSNetworkAdapter new]]]; - ``` @@ -90,7 +89,6 @@ Initialise the plugin in the following way by updating AppDelegate.m: import FlipperKit client?.add(FlipperKitNetworkPlugin(networkAdapter: SKIOSNetworkAdapter())) - ```