Skip to main content

api_studio 1.2.0 copy "api_studio: ^1.2.0" to clipboard
api_studio: ^1.2.0 copied to clipboard

In-app API inspector for Flutter: capture Dio, http or custom requests with redaction, edit & replay, cURL/HAR/Postman export, performance monitor and cloud logs.

example/lib/main.dart

import 'dart:async';

import 'package:api_studio/api_studio.dart';
import 'package:flutter/material.dart';

import 'screens/basic_get_screen.dart';
import 'screens/post_screen.dart';
import 'screens/put_screen.dart';
import 'screens/patch_screen.dart';
import 'screens/delete_screen.dart';
import 'screens/network_failure_screen.dart';
import 'screens/error_screen.dart';
import 'screens/unauthorized_screen.dart';
import 'screens/server_error_screen.dart';
import 'screens/timeout_screen.dart';
import 'screens/retry_screen.dart';
import 'screens/upload_screen.dart';
import 'screens/download_screen.dart';
import 'screens/progress_screen.dart';
import 'screens/cookies_screen.dart';
import 'screens/cache_screen.dart';
import 'screens/proxy_screen.dart';
import 'screens/ssl_screen.dart';
import 'screens/cancellation_screen.dart';
import 'screens/parallel_screen.dart';
import 'screens/sequential_screen.dart';
import 'screens/batch_screen.dart';
import 'screens/duplicate_screen.dart';
import 'screens/interceptor_screen.dart';
import 'screens/dio_screen.dart';
import 'screens/http_screen.dart';
import 'widgets/failed_api_badge.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // One call configures everything. `enabled` defaults to kDebugMode, so
  // API Studio is a no-op in release builds unless you opt in.
  await ApiStudio.initialize(
    apiKey: null, // add your apistudio.cloud key to enable cloud logging
    // Optional built-in client used by the "Built-in client" demos below.
    baseUrl: 'https://jsonplaceholder.typicode.com',
    enableConnectivityStream: true,
    enableFailedApiStream: true,
    enablePerformanceMonitoring: true,
    // Add-on tabs next to API Logs.
    features: {ApiStudioFeature.performance, ApiStudioFeature.fileExplorer},
    appVersion: '1.0.0',
    redaction: const RedactionConfig(redactBodyKeys: ['ssn']),
  );
  runApp(const ExampleApp());
}

class ExampleApp extends StatelessWidget {
  const ExampleApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'API Studio Demo',
      debugShowCheckedModeBanner: false,
      // Lets ApiStudio.open() / the floating button work without a context.
      navigatorKey: ApiStudio.navigatorKey,
      theme: ThemeData(colorSchemeSeed: Colors.indigo, useMaterial3: true),
      home: const HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  const HomeScreen({super.key});

  @override
  State<HomeScreen> createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  late final StreamSubscription<bool> _connectivitySub;
  late final StreamSubscription<int> _failedCountSub;
  int _failedApiCount = ApiStudio.failedApiCount;

  static const _integrationDemos = <_DemoItem>[
    _DemoItem('Dio interceptor', Icons.bolt_rounded, Colors.deepPurple),
    _DemoItem('package:http client', Icons.http_rounded, Colors.teal),
  ];

  static final _integrationScreens = <Widget>[
    const DioScreen(),
    const HttpScreen(),
  ];

  static const _demos = <_DemoItem>[
    _DemoItem('1. Basic GET', Icons.download_rounded, Colors.blue),
    _DemoItem('2. POST Request', Icons.upload_rounded, Colors.green),
    _DemoItem('3. PUT Request', Icons.edit_rounded, Colors.lightGreen),
    _DemoItem('4. PATCH Request', Icons.edit_note_rounded, Colors.lime),
    _DemoItem('5. DELETE Request', Icons.delete_rounded, Colors.redAccent),
    _DemoItem('6. Error (400)', Icons.warning_rounded, Colors.orange),
    _DemoItem('7. Unauthorized (401)', Icons.lock_rounded, Colors.red),
    _DemoItem('8. Server Error (500)', Icons.cloud_off_rounded, Colors.red),
    _DemoItem('9. Timeout', Icons.timer_off_rounded, Colors.amber),
    _DemoItem('10. Network Failure', Icons.wifi_off_rounded, Colors.deepPurple),
    _DemoItem('11. Retry', Icons.replay_rounded, Colors.teal),
    _DemoItem('12. Upload', Icons.cloud_upload_rounded, Colors.purple),
    _DemoItem('13. Download', Icons.cloud_download_rounded, Colors.indigo),
    _DemoItem('14. Progress', Icons.linear_scale_rounded, Colors.cyan),
    _DemoItem('15. Cookies', Icons.cookie_rounded, Colors.brown),
    _DemoItem('16. Cache', Icons.storage_rounded, Colors.blueGrey),
    _DemoItem('17. Proxy', Icons.router_rounded, Colors.deepOrange),
    _DemoItem('18. SSL', Icons.security_rounded, Colors.green),
    _DemoItem('19. Cancellation', Icons.cancel_rounded, Colors.pink),
    _DemoItem('20. Parallel Requests', Icons.sync_alt_rounded, Colors.blue),
    _DemoItem('21. Sequential Requests', Icons.list_rounded, Colors.teal),
    _DemoItem(
      '22. Batch Requests',
      Icons.batch_prediction_rounded,
      Colors.orange,
    ),
    _DemoItem(
      '23. Duplicate Prevention',
      Icons.filter_none_rounded,
      Colors.purple,
    ),
    _DemoItem('24. Interceptors', Icons.layers_rounded, Colors.indigo),
  ];

  static final _screens = <Widget>[
    const BasicGetScreen(),
    const PostScreen(),
    const PutScreen(),
    const PatchScreen(),
    const DeleteScreen(),
    const ErrorScreen(),
    const UnauthorizedScreen(),
    const ServerErrorScreen(),
    const TimeoutScreen(),
    const NetworkFailureScreen(),
    const RetryScreen(),
    const UploadScreen(),
    const DownloadScreen(),
    const ProgressScreen(),
    const CookiesScreen(),
    const CacheScreen(),
    const ProxyScreen(),
    const SslScreen(),
    const CancellationScreen(),
    const ParallelScreen(),
    const SequentialScreen(),
    const BatchScreen(),
    const DuplicateScreen(),
    const InterceptorScreen(),
  ];

  @override
  void initState() {
    super.initState();
    _connectivitySub = ApiStudio.internetConnectivityStream.listen(
      (connected) => _snack(connected ? 'Internet Connected' : 'No Internet'),
    );
    _failedCountSub = ApiStudio.failedApiCountStream.listen(
      (c) => setState(() => _failedApiCount = c),
    );
    // Optional draggable debug button that opens API Studio.
    WidgetsBinding.instance.addPostFrameCallback(
      (_) => ApiStudio.showFloatingButton(context),
    );
  }

  @override
  void dispose() {
    _connectivitySub.cancel();
    _failedCountSub.cancel();
    super.dispose();
  }

  void _snack(String msg) {
    if (!mounted) return;
    ScaffoldMessenger.of(context)
      ..hideCurrentSnackBar()
      ..showSnackBar(
        SnackBar(
          content: Text(msg),
          behavior: SnackBarBehavior.floating,
          duration: const Duration(seconds: 2),
        ),
      );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.white,
      appBar: AppBar(
        backgroundColor: Colors.white,
        title: const Text('API Studio Demo'),
        actions: [
          FailedApiBadge(count: _failedApiCount),
          IconButton(
            icon: const Icon(Icons.dashboard_customize_rounded),
            tooltip: 'Open API Studio',
            onPressed: () => ApiStudio.showNavigation(context),
          ),
        ],
      ),
      body: ListView(
        padding: const EdgeInsets.symmetric(vertical: 12, horizontal: 16),
        children: [
          const _SectionHeader('Integrations (recommended)'),
          for (var i = 0; i < _integrationDemos.length; i++)
            _DemoTile(
                item: _integrationDemos[i], screen: _integrationScreens[i]),
          const _SectionHeader(
            'Built-in ApiStudioClient (optional, for manual testing)',
          ),
          for (var i = 0; i < _demos.length; i++)
            _DemoTile(item: _demos[i], screen: _screens[i]),
        ],
      ),
    );
  }
}

class _SectionHeader extends StatelessWidget {
  final String text;
  const _SectionHeader(this.text);

  @override
  Widget build(BuildContext context) {
    return Padding(
      padding: const EdgeInsets.fromLTRB(4, 16, 4, 8),
      child: Text(text, style: Theme.of(context).textTheme.titleSmall),
    );
  }
}

class _DemoTile extends StatelessWidget {
  final _DemoItem item;
  final Widget screen;
  const _DemoTile({required this.item, required this.screen});

  @override
  Widget build(BuildContext context) {
    return Card(
      elevation: 1,
      color: Colors.white,
      margin: const EdgeInsets.symmetric(vertical: 4),
      shape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(12)),
      child: ListTile(
        leading: CircleAvatar(
          backgroundColor: item.color.withValues(alpha: 0.15),
          child: Icon(item.icon, color: item.color, size: 16),
        ),
        title: Text(
          item.title,
          style: const TextStyle(fontWeight: FontWeight.w500, fontSize: 14),
        ),
        trailing: const Icon(Icons.chevron_right_rounded),
        onTap: () => Navigator.push(
          context,
          MaterialPageRoute<void>(builder: (_) => screen),
        ),
      ),
    );
  }
}

class _DemoItem {
  final String title;
  final IconData icon;
  final Color color;
  const _DemoItem(this.title, this.icon, this.color);
}
9
likes
0
points
710
downloads

Publisher

verified publisherapistudio.cloud

Weekly Downloads

In-app API inspector for Flutter: capture Dio, http or custom requests with redaction, edit & replay, cURL/HAR/Postman export, performance monitor and cloud logs.

Repository (GitHub)
View/report issues

Topics

#network #debugging #http #inspector #devtools

License

unknown (license)

Dependencies

equatable, flutter, hive_ce, path_provider, share_plus, url_launcher, web

More

Packages that depend on api_studio