ispectify_dio 4.1.3-dev12

ispectify_dio: ^4.1.3-dev12 copied to clipboard

Dio HTTP client integration for ISpectify logging system

🔍 Overview #

ISpectify Dio provides seamless integration between Dio HTTP client and the ISpectify logging system.

Streamline your HTTP debugging workflow by automatically capturing and logging all Dio HTTP client interactions. Perfect for monitoring API calls, debugging network issues, and tracking performance metrics.

🎯 Key Features #

• 🌐 HTTP Request Logging: Automatic logging of all Dio requests
• 📊 Response Tracking: Detailed response logging with timing information
• ❌ Error Handling: Comprehensive error logging with stack traces
• 🔍 Request Inspection: Headers, body, and parameter logging
• ⚡ Performance Metrics: Request/response timing and size tracking
• 🎛️ Configurable: Flexible configuration options for different environments

🔧 Configuration Options #

Basic Configuration #

final interceptor = ISpectifyDioInterceptor(
  ispectify: ispectify,
  settings: ISpectifyDioSettings(
    // Request logging
    printRequestHeaders: true,
    printRequestBody: true,
    
    // Response logging
    printResponseHeaders: true,
    printResponseBody: true,
    
    // Error handling
    printErrorDetails: true,
    
    // Performance
    trackRequestTime: true,
  ),
);

Advanced Filtering #

final interceptor = ISpectifyDioInterceptor(
  ispectify: ispectify,
  settings: ISpectifyDioSettings(
    // Filter sensitive headers
    headerFilter: (headers) => headers..remove('Authorization'),
    
    // Filter request bodies
    requestBodyFilter: (body) {
      if (body is Map) {
        return Map.from(body)..remove('password');
      }
      return body;
    },
    
    // Custom log levels
    requestLogLevel: LogLevel.debug,
    responseLogLevel: LogLevel.info,
    errorLogLevel: LogLevel.error,
  ),
);

📦 Installation #

Add ispectify_dio to your pubspec.yaml:

dependencies:
  ispectify_dio: ^4.1.3

🚀 Quick Start #

import 'package:dio/dio.dart';
import 'package:ispectify_dio/ispectify_dio.dart';
import 'package:ispectify/ispectify.dart';

void main() {
  final ispectify = ISpectify();
  
  // Create Dio instance with ISpectify interceptor
  final dio = Dio()
    ..interceptors.add(
      ISpectifyDioInterceptor(
        ispectify: ispectify,
        settings: ISpectifyDioSettings(
          printRequestHeaders: true,
          printResponseHeaders: true,
          printRequestBody: true,
          printResponseBody: true,
        ),
      ),
    );
  
  // All HTTP requests will be automatically logged
  final response = await dio.get('https://api.example.com/data');
}

⚙️ Advanced Features #

Custom Log Formatting #

final interceptor = ISpectifyDioInterceptor(
  ispectify: ispectify,
  settings: ISpectifyDioSettings(
    requestFormatter: (request) => 'API Call: ${request.method} ${request.uri}',
    responseFormatter: (response) => 'Response: ${response.statusCode} (${response.data?.length ?? 0} bytes)',
  ),
);

Environment-based Configuration #

final interceptor = ISpectifyDioInterceptor(
  ispectify: ispectify,
  settings: kDebugMode 
    ? ISpectifyDioSettings.debug() // Full logging in debug
    : ISpectifyDioSettings.production(), // Minimal logging in production
);

Multiple Dio Instances #

// API client
final apiDio = Dio()
  ..interceptors.add(
    ISpectifyDioInterceptor(
      ispectify: ispectify,
      tag: 'API',
    ),
  );

// Analytics client
final analyticsDio = Dio()
  ..interceptors.add(
    ISpectifyDioInterceptor(
      ispectify: ispectify,
      tag: 'Analytics',
    ),
  );

📚 Examples #

See the example/ directory for complete integration examples with different Dio configurations.

🏗️ Architecture #

ISpectifyDio integrates with the Dio HTTP client through interceptors:

🤝 Contributing #

Contributions are welcome! Please read our contributing guidelines and submit pull requests to the main branch.

📄 License #

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Related Packages #

• ispectify - Foundation logging system
• ispectify_http - Standard HTTP client integration
• ispect - Main debugging interface
• dio - HTTP client for Dart

Built with ❤️ for the Flutter community