Gander

What is this library about?

Gander is a simple in-app HTTP inspector for Android OkHttp clients. Gander intercepts and persists all HTTP requests and responses inside your application, and provides a UI for inspecting their content.

get sample apk from Google Play Store

Features

Apps using Gander will display a notification showing a summary of ongoing HTTP activity. Tapping on the notification launches the full Gander UI. Apps can optionally suppress the notification, and launch the Gander UI directly from within their own interface. HTTP interactions and their contents can be exported via a share intent.
Search HTTP Activity and also request and response
The main Gander activity is launched in its own task, allowing it to be displayed alongside the host app UI using Android 7.x multi-window support.

Gander requires Android 4.1+ and OkHttp 3.x.

Warning: The data generated and stored when using this interceptor may contain sensitive information such as Authorization or Cookie headers, and the contents of request and response bodies. It is intended for use during development, and not in release builds or other production deployments.

Setup

Download

Based on your IDE you can import library in one of the following ways

Gradle:

Add the dependency in your build.gradle file. Add it alongside the no-op variant to isolate Gander from release builds as follows:

debugImplementation 'com.ashokvarma.android:gander:1.3.3'
releaseImplementation 'com.ashokvarma.android:gander-no-op:1.3.3'

If you want this in library in both release and compile, then try this :

implementation 'com.ashokvarma.android:gander:1.3.3'

or grab via Maven:

<dependency>
  <groupId>com.ashokvarma.android</groupId>
  <artifactId>gander</artifactId>
  <version>1.3.3</version>
  <type>pom</type>
</dependency>

or Download the latest JAR

Usage

In your application code, create an instance of GanderInterceptor (you'll need to provide it with a Context, because Android) and add it as an interceptor when building your OkHttp client:

OkHttpClient client = new OkHttpClient.Builder()
  .addInterceptor(new GanderInterceptor(context, true))
  .build();

That's it! Gander will now record all HTTP interactions made by your OkHttp client. You can optionally disable the notification by passing false in constructor new GanderInterceptor(context, false)

Other Features

Launch the Gander UI directly within your app with the intent from Gander.getLaunchIntent().

startActivity(Gander.getLaunchIntent(this));

Add app shortcut to your app

Gander.addAppShortcut(this);

FAQ

Why are some of my request headers missing?
Why are retries and redirects not being captured discretely?
Why are my encoded request/response bodies not appearing as plain text?

Please refer to this section of the OkHttp wiki. You can choose to use Gander as either an application or network interceptor, depending on your requirements.

Diff between Chuck and Gander:

Gander uses Room for db instead of Cupboard
Removed Gson Dependency
Improved Search
Improved Performance (PagedList, BackGround Load for Text, other minor pref boosts)
Minor fixes (Notification Channel Creation ..etc)
Many new features (Search highlight, app shortcut, Improved Notifications ..etc)

Acknowledgements

Chuck (parent repo)

Chuck - Copyright Jeff Gilfelt, Inc.

Thanks to Jeff Gilfelt for his amazing library Chuck. This repo is a fork from Chuck, later on moved and released as separate project, since chuck is no longer maintained.

Awesome Icon Designer

Jibbie Eguna - He contributed the Icon to Gander.

Gander uses the following open source libraries:

OkHttp - Copyright Square, Inc.

License

Copyright (C) 2018 Ashok Varma.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Other Open Source Libraries

SqliteManager : Sqlite Manager is a Dev Debug tool that helps to manage(Edit, Add, Clear) your android Sqlite Databases.
SharedPrefManager : SharedPref Manager is a Dev Debug tool that helps to manage(Edit, Add, Clear) your android Shared Preferences.
BottomNavigation : This Library helps users to use Bottom Navigation Bar (A new pattern from google) with ease and allows ton of customizations.

maoqis/Gander