Easy to use, http client class debugger & logger for multiple http client. This package contains a set of high-level functions and classes that make it easy to log / debug HTTP activities on the fly. It's also depend on Dio and Http package.
|
|
|
|
Material 3 & Dark mode support 🆕
Now you can use your favorite material 3 theme and dark mode, starting from version 1.0.4
|
|
|
|
Get Started
add dependency
dependencies:
network_inspector: ^1.0.0
Initialize
Initialize network inspector, call initialize method to init the local database sqlite. You can use WidgetsFlutterBinding.ensureInitialized(); to makesure widget flutter binding initialized before initialize network inspector.
void main() {
WidgetsFlutterBinding.ensureInitialized();
NetworkInspector.initialize();
runApp(const ExampleApp());
}
Dio Users
- Add interceptor class
DioInterceptorfor dio client. - Create another Network Inspector class to used on the
DioInterceptorconstructor. - use
onHttpFinishas a callback when http activities is finish (Can be success/error)
/// Client Declaration
Dio get dioClient{
final networkInspector = NewtworkInspector();
final client = Dio()..interceptors.add(
DioInterceptor(
logIsAllowed: true,
networkInspector: networkInspector,
onHttpFinish: (hashCode, title, message) {
notifyActivity(
title: title,
message: message,
);
},
),
);
return client;
}
/// Use dio regularly
/// Every request, response & error will automatically fetched & stored by the network inspector.
/// And also if the properties of declared `DioInterceptor` is not empty, it will set every properties as default.
await dioClient.post('/test', data: {'id': 1, 'name': 'jhon folks'});
Http Users
- Add interceptor class
HttpInterceptorfor dio client. - Initialize
Clientto client class, then useclienton theHttpInterceptorconstructor - Create another Network Inspector class to used on the
DioInterceptorconstructor. - use
onHttpFinishas a callback when http activities is finish (Can be success/error)
HttpInterceptor get httpClient {
final networkInspector = NewtworkInspector();
final client = Client();
final interceptor = HttpInterceptor(
logIsAllowed: true,
client: client,
baseUrl: Uri.parse('http://192.168.1.3:8000/'),
networkInspector: networkInspector,
onHttpFinish: (hashCode, title, message) {
notifyActivity(
title: title,
message: message,
);
},
headers: {
'Content-type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer WEKLSSS'
},
);
return interceptor;
}
/// Use http client regularly
/// Every request, response & error will automatically fetched & stored by the network inspector.
/// And also if the properties of declared `HttpInterceptor` is not empty, it will set every properties as default.
await httpClient.post(url, body: {'name': 'doodle', 'color': 'blue'});
Acessing the UI
We can use regular Navigator.push, we decide to use MaterialPageRoute instead of named route to avoid tightly coupled.
/// Use this on floating button / notification handler.
void goToActivityPage(BuildContext context){
await Navigator.push(
context,
MaterialPageRoute<void>(
builder: (context) => ActivityPage(),
),
);
}
Entry point from notification tap action
If the entry point to http activity page is desired from notification tap action, create a class to store GlobalKey<NavigatorState> which we need to navigate to the http activity page, from anywhere add GlobalKey into the MaterialApp widget on the navigatorKey constructor.
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Network inspector',
theme: ThemeData(
primarySwatch: Colors.blue,
),
/// Put your navigation key into a class
/// In this case we put navigator key on
/// ```dart
/// class NavigationService{
/// static var navigatorKey = GlobalKey<NavigatorState>();
/// }
/// ```
navigatorKey: NavigationService.navigatorKey,
initialRoute: MainPage.routeName,
routes: NavigationService.routes,
),
}
Then you can use the global key to get the context for Navigator.push
/// Get the current context
var context = NavigationService.navigatorKey.currentContext;
/// Call the `goToActivityPage` method and Supply the context
goToActivityPage(context);
Libraries
- presentation/pages/activity_detail_page
- presentation/controllers/activity_detail_provider
- presentation/controllers/activity_filter_provider
- presentation/pages/activity_page
- presentation/controllers/activity_provider
- common/widgets/bottom_sheet
- common/extensions/byte_extension
- common/utils/byte_util
- presentation/widgets/container_label
- presentation/widgets/content_container
- common/base/data_wrapper
- common/utils/database_helper
- common/utils/date_time_util
- infrastructure/models/definition_model
- common/utils/dio_interceptor
- domain/usecases/fetch_http_activities
- domain/usecases/fetch_http_requests
- domain/usecases/fetch_http_responses
- presentation/widgets/filter_bottom_sheet_content
- domain/entities/http_activity
- infrastructure/mappers/http_activity_mapper
- infrastructure/models/http_activity_model
- presentation/pages/http_error_page
- common/utils/http_interceptor
- domain/entities/http_request
- infrastructure/mappers/http_request_mapper
- infrastructure/models/http_request_model
- presentation/pages/http_request_page
- domain/entities/http_response
- infrastructure/mappers/http_response_mapper
- infrastructure/models/http_response_model
- presentation/pages/http_response_page
- common/extensions/json_extension
- common/utils/json_util
- infrastructure/datasources/log_datasource
- infrastructure/datasources/log_datasource_impl
- domain/usecases/log_http_request
- domain/usecases/log_http_response
- domain/repositories/log_repository
- infrastructure/repositories/log_repository_impl
- infrastructure/models/map_to_table
- network_inspector
- const/network_inspector_enum
- const/network_inspector_value
- presentation/widgets/section_title
- presentation/widgets/titled_label
- common/extensions/unix_extension
- common/extensions/url_extension
- common/utils/url_util
- common/utils/use_case