chucker-flutter

KO | EN

gitlite — search

#python #react #llm #go #machine-learning #deep-learning #linux #macos #java #cli #kubernetes #pytorch #mcp #ios

chucker-flutter

(★ 84)

An HTTP requests inspector inspired by Chucker Android

chucker-flutter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Stand With Palestine](https://raw.githubusercontent.com/TheBSD/StandWithPalestine/main/banner-no-action.svg)](https://thebsd.github.io/StandWithPalestine)

* [Getting Started](#getting-started)
* [Features](#features)
* [Libraries](#libraries)
* [License](#license)

# Chucker Flutter

[![StandWithPalestine](https://raw.githubusercontent.com/TheBSD/StandWithPalestine/main/badges/StandWithPalestine.svg)](https://github.com/TheBSD/StandWithPalestine/blob/main/docs/README.md)

An HTTP requests inspector inspired by <a href="https://github.com/ChuckerTeam/chucker">Chucker Android</a>

Chucker Flutter inspects the **HTTP(S) requests/responses** triggered by your Flutter App. It works as an **Interceptor** and stores data related to network requests and responses on local storage, and providing a UI for inspecting and sharing their content.

Flutter Apps, using Chucker Flutter, show in-app **notifications** which tell the status (e.g. 200, 400, 500 and so) and requested url and upon clicking on details button it navigates to Chucker Flutter main screen. You can manipulate Chucker Flutter behaviour using its setting by navigating to Settings page from the menu button of Chucker Flutter main page.

# Getting Started

To use Chucker Flutter you need to add the  **pub spec dependency** to your `pubspec.yaml` file of your flutter app.

Please verify the current latest version of Chucker Flutter so that you can enjoy the latest features.

```yaml
dependencies:
  chucker_flutter: latest-version
```

just run the command
```
flutter pub add chucker_flutter
```

To make `Chucker Flutter` work in `Dio`, just add it in your `Dio` object e.g.:

```dart
Dio().interceptors.add(ChuckerDioInterceptor());
```

To make `Chucker Flutter` work in `Http`, you need to use `ChuckerHttpClient`  object e.g.:

```dart
final _chuckerHttpClient = ChuckerHttpClient(http.Client());
_chuckerHttpClient.get(Uri.parse('$_baseUrl$path'));
```

To make `Chucker Flutter` work in `Chopper`, you need to use `ChuckerChopperInterceptor`  object e.g.:

```dart
final client = ChopperClient(
        baseUrl: 'https://jsonplaceholder.typicode.com',
        interceptors: [
          ChuckerChopperInterceptor(),
        ]
);
```

The very last thing is to connect Chucker Flutter screens to your app by wiring `ChuckerFlutter.navigatorKey` into whichever widget owns your root `Navigator`.

**`MaterialApp` (most apps)**

```dart
MaterialApp(
  navigatorKey: ChuckerFlutter.navigatorKey,
  ...,
);
```

**`MaterialApp.router` with GoRouter**

`MaterialApp.router` does not accept a `navigatorKey` — pass it to `GoRouter` instead:

```dart
final _router = GoRouter(
  navigatorKey: ChuckerFlutter.navigatorKey,
  routes: [...],
);

MaterialApp.router(
  routerConfig: _router,
  ...,
);
```

**`MaterialApp.router` with a custom `RouterDelegate`**

Pass `ChuckerFlutter.navigatorKey` to your delegate's constructor and use it as the key on its root `Navigator`:

```dart
class AppRouterDelegate extends RouterDelegate<...> {
 AppRouterDelegate() : navigatorKey = ChuckerFlutter.navigatorKey;

@override
 final GlobalKey<NavigatorState> navigatorKey;

@override
  Widget build(BuildContext context) {
    return Navigator(
      key: navigatorKey,
      pages: [...],
      onDidRemovePage: ...,
    );
  }
}
```

> The previous `navigatorObservers: [ChuckerFlutter.navigatorObserver]` integration is deprecated and unreliable with nested navigators — it still works as a fallback so existing apps keep running, but new integrations should use `navigatorKey`.

By default Chucker Flutter only runs in `debug` mode but you can allow it to run in release mode too using its `showOnRelease` property  e.g.:

```dart
void main() {
  ChuckerFlutter.showOnRelease = true;
  runApp(const App());
}
```

**Congratulations!** 🎊 You are done. Rest on us!

## Features

* Support for **Dio** and **Http**
* Works in all (Windows💻, Linux🖥️, Mac🧑‍💻, Web🌍, Android📱, iOS📲) platforms (⚠️For android you need to make minSdkVersion **22** in build.gradle file)
* Easy integration
* Customization
* Localization (Current support for English 🇺🇸 and Urdu 🇵🇰)
* Searching🔍 and sharing👯
* Json request and responses in tree form
* Json request and response in pretty json format
* Image URL preview
* `ChuckerHttpLoggingInterceptor` for better readability of http request and response sent from client. To use this just add this interceptor in your `ChopperClient`

```dart
final exampleClient = ChopperClient(
  services: [
    _$ChopperApiService(),
  ],
  interceptors: [
    ChuckerHttpLoggingInterceptor() //This for logging,
    ChuckerChopperInterceptor(),
  ],
);
```

![image](https://user-images.githubusercontent.com/44249868/206827243-e97a9465-b165-4af8-96a1-d48ea871164e.png)

### Libraries

Chucker FLutter uses the following open source libraries:

- [dio](https://pub.dev/packages/dio) - flutterchina.club
- [shared_preferences](https://pub.dev/packages/shared_preferences) - flutter.dev
- [share_plus](https://pub.dev/packages/share_plus) - fluttercommunity.dev
- [http](https://pub.dev/packages/http) - dart.dev
- [Chopper](https://pub.dev/packages/chopper) - hadrienlejard.io

## Patrons

I extend my sincere appreciation to all the sponsors. Thank you for making a difference in the open source community!❤️ (You can also sponsor my work, please visit [patreon.com](https://patreon.com/syedmurtaza?utm_medium=clipboard_copy&utm_source=copyLink&utm_campaign=creatorshare_creator&utm_content=join_link))

<table>
 <tr>
 <td align="center"><a href="https://github.com/rafayali"><img src="https://avatars.githubusercontent.com/u/1373965?v=4" width="100px;" alt=""/> Rafay Ali</a> </td>
 </tr>
 
</table>

## Contributors

Special thanks to these wonderful people👏 who are making our community bigger and better🔥

<table>
 <tr>
 <td align="center"><a href="https://github.com/Dammyololade"><img src="https://avatars.githubusercontent.com/u/44375103?v=4?s=100" width="100px;" alt=""/> Adeyemo Adedamola</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=Dammyololade" title="Documentation">📖</a> </td>
 <td align="center"><a href="https://github.com/fachrifaul"><img src="https://avatars.githubusercontent.com/u/2288266?v=4" width="100px;" alt=""/> fachrifaul</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=fachrifaul" title="Documentation">📖</a> </td>
 <td align="center"><a href="https://github.com/navneet-singh-github"><img src="https://avatars.githubusercontent.com/u/94953723?v=4" width="100px;" alt=""/> Navneet Singh</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=navneet-singh-github" title="Documentation">📖</a> </td>
 <td align="center"><a href="https://github.com/Serproger"><img src="https://avatars.githubusercontent.com/u/11074431?v=4" width="100px;" alt=""/> Sergei</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=Serproger" title="Documentation">📖</a> </td>
 </tr>
 <tr>
 <td align="center"><a href="https://github.com/SyifaAinnur"><img src="https://avatars.githubusercontent.com/u/62318101?v=4" width="100px;" alt=""/> Syifa Ainnur</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=SyifaAinnur" title="Documentation">📖</a> </td>

<td align="center"><a href="https://github.com/ErickArmen"><img src="https://avatars.githubusercontent.com/u/37030822?v=4" width="100px;" alt=""/> Erick Armen</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=ErickArmen" title="Documentation">📖</a> </td>
 <td align="center"><a href="https://github.com/Wreos"><img src="https://avatars.githubusercontent.com/u/15965366?v=4" width="100px;" alt=""/> Aleksandr Lozhkovoi</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=Wreos" title="Documentation">📖</a> </td>
 <td align="center"><a href="https://github.com/quango2304"><img src="https://avatars.githubusercontent.com/u/39608754?v=4" width="100px;" alt=""/> Leo Ngo</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=quango2304" title="Documentation">📖</a> </td>
 </tr>
 <tr>
 <td align="center"><a href="https://github.com/KashyapBhat"><img src="https://avatars.githubusercontent.com/u/23421932?v=4" width="100px;" alt=""/> Kashyap Bhat</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=KashyapBhat" title="Documentation">📖</a> </td>

<td align="center"><a href="https://github.com/KeeganDC"><img src="https://avatars.githubusercontent.com/u/97861347?v=4" width="100px;" alt=""/> KeeganDC</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=KeeganDC" title="Documentation">📖</a> </td>

<td align="center"><a href="https://github.com/mateendev3"><img src="https://avatars.githubusercontent.com/u/81102550?v=4" width="100px;" alt=""/> Mateen Mehmood</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=mateendev3" title="Documentation">📖</a> </td>

<td align="center"><a href="https://github.com/CuongNV12"><img src="https://avatars.githubusercontent.com/u/53120409?v=4" width="100px;" alt=""/> Cuong Nguyen</a> <a href="https://github.com/syedmurtaza108/chucker-flutter/commits?author=CuongNV12" title="Documentation">📖</a> </td>
 </tr>
 
</table>

## License

```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

chucker-flutter

chucker-flutter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

chucker-flutter

chucker-flutter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README