syedmurtaza108/chucker-flutter

Stand With Palestine

Chucker Flutter

Codecov Badge Pub.dev Badge Popularity GitHub Build Badge MIT License Badge Flutter Platform Badge Stars Developed By Badge

• Getting Started
• Features
• Libraries
• License

Chucker Flutter

StandWithPalestine

An HTTP requests inspector inspired by Chucker Android

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.

chucker http sample

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.

dependencies:
  chucker_flutter: latest-version

or

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.:

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

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

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.:

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)

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

MaterialApp.router with GoRouter

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

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:

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.:

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

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

image

Libraries

Chucker FLutter uses the following open source libraries:

• dio - flutterchina.club
• shared_preferences - flutter.dev
• share_plus - fluttercommunity.dev
• http - dart.dev
• 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://avatars.githubusercontent.com/u/1373965?v=4 Rafay Ali

Contributors

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

https://avatars.githubusercontent.com/u/44375103?v=4?s=100 Adeyemo Adedamola 📖	https://avatars.githubusercontent.com/u/2288266?v=4 fachrifaul 📖	https://avatars.githubusercontent.com/u/94953723?v=4 Navneet Singh 📖	https://avatars.githubusercontent.com/u/11074431?v=4 Sergei 📖
https://avatars.githubusercontent.com/u/62318101?v=4 Syifa Ainnur 📖	https://avatars.githubusercontent.com/u/37030822?v=4 Erick Armen 📖	https://avatars.githubusercontent.com/u/15965366?v=4 Aleksandr Lozhkovoi 📖	https://avatars.githubusercontent.com/u/39608754?v=4 Leo Ngo 📖
https://avatars.githubusercontent.com/u/23421932?v=4 Kashyap Bhat 📖	https://avatars.githubusercontent.com/u/97861347?v=4 KeeganDC 📖	https://avatars.githubusercontent.com/u/81102550?v=4 Mateen Mehmood 📖	https://avatars.githubusercontent.com/u/53120409?v=4 Cuong Nguyen 📖

License

MIT License

Copyright (c) 2022 Syed Murtaza

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.