Files
flipper/docs/setup/network-plugin.md
Pascal Hartig 741fb7d292 Update docs for new plugins
Summary: ilovedocs

Reviewed By: danielbuechele

Differential Revision: D17501537

fbshipit-source-id: 1f5d872928b5a644ee98db025ad60b038b7126a8
2019-09-23 06:18:14 -07:00

1.7 KiB

id, title, sidebar_label
id title sidebar_label
network-plugin Network Setup Network

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:

dependencies {
  debugImplementation 'com.facebook.flipper:flipper-network-plugin:0.24.0'
}

Once added to your dependencies, you can instantiate the plugin and add it to the client:

import com.facebook.flipper.plugins.network.NetworkFlipperPlugin;

NetworkFlipperPlugin networkFlipperPlugin = new NetworkFlipperPlugin();
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.

import com.facebook.flipper.plugins.network.FlipperOkhttpInterceptor;

new OkHttpClient.Builder()
    .addNetworkInterceptor(new FlipperOkhttpInterceptor(networkFlipperPlugin))
    .build();

As interceptors can modify the request and response, add the Flipper interceptor after all others to get an accurate view of the network traffic.

iOS

To enable network inspection, add the following pod to your Podfile:

pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version

Initialise the plugin in the following way:

#import <FlipperKitNetworkPlugin/FlipperKitNetworkPlugin.h>

[[FlipperClient sharedClient] addPlugin: [[FlipperKitNetworkPlugin alloc] initWithNetworkAdapter:[SKIOSNetworkAdapter new]]];

import FlipperKit

client?.add(FlipperKitNetworkPlugin(networkAdapter: SKIOSNetworkAdapter()))