Flutter网络请求辅助插件api_request_helper的使用

Flutter网络请求辅助插件api_request_helper的使用

API Helper

api_request_helper 是一个全面的 Flutter 包，通过提供直观的接口简化 REST API 操作。此包通过集成认证、重试逻辑和 WebSocket 支持来简化常见的 API 任务，如获取、更新、删除和可视化 API 数据。

特性

• 清晰且可扩展的 HTTP 操作 API。
• 内置的 JSON 解析、错误处理和指标跟踪。
• 基于令牌的身份验证支持。
• 支持：
  • 获取列表数据（GET）。
  • 使用查询参数获取数据（GET）。
  • 更新数据（PUT）。
  • 删除数据（DELETE）。
  • 获取分页数据。
  • 可视化 API 数据层次结构。
  • 带有指数退避的请求重试逻辑。
  • 可配置的超时和动态环境切换。
  • 实时数据流传输的 WebSocket 支持。

入门指南

在你的 Flutter 项目中添加此包，请将以下内容添加到 pubspec.yaml 文件：

dependencies:
  api_request_helper: ^0.1.4

安装包：

flutter pub get

使用方法

初始化 API Helper

首先，初始化 ApiHelper 并设置不同的环境的基本 URL：

final apiHelper = ApiHelper(
  environments: {
    'development': 'https://dev.api.example.com',
    'staging': 'https://staging.api.example.com',
    'production': 'https://api.example.com',
  },
  currentEnvironment: 'production',
);

// 设置身份验证令牌
apiHelper.setAuthToken('your-auth-token');

获取列表数据

try {
  List<dynamic> result = await apiHelper.fetchData('/users');
  print(result);
} catch (e) {
  print('Error: $e');
}

获取带查询参数的数据

try {
  final queryParams = {
    'page': '1',
    'limit': '10',
  };

  Map<String, dynamic> result = await apiHelper.fetchDataWithQuery(
    '/users',
    queryParams
  );
  print(result);
} catch (e) {
  print('Error: $e');
}

更新数据

try {
  final updates = {
    'name': 'John Doe',
    'email': 'john@example.com'
  };

  Map<String, dynamic> result = await apiHelper.editData(
    '/users/1',
    updates
  );
  print(result);
} catch (e) {
  print('Error: $e');
}

删除数据

try {
  bool success = await apiHelper.deleteData('/users/1');
  if (success) {
    print('Successfully deleted');
  }
} catch (e) {
  print('Error: $e');
}

获取分页数据

try {
  List<dynamic> result = await apiHelper.fetchPaginatedData('/users', page: 1, limit: 10);
  print(result);
} catch (e) {
  print('Error: $e');
}

生成 API 数据层次结构

try {
  String hierarchy = await apiHelper.generateHierarchyMap('/users');
  print(hierarchy);
} catch (e) {
  print('Error: $e');
}

WebSocket 支持

final wsHelper = WebSocketHelper('wss://api.example.com/socket');
wsHelper.stream.listen((event) {
  print('New message: $event');
});

额外信息

最低要求

• Dart SDK: >=3.0.0 <4.0.0
• Flutter: >=3.0.0

依赖项

• http: ^1.1.0
• web_socket_channel: ^2.2.0

错误处理

该包抛出带有详细消息和状态码的自定义异常（ApiException）。始终将 API 调用包装在 try-catch 块中以进行适当的错误处理。

指标跟踪

跟踪 API 使用情况和性能：

print('Total Requests: ${apiHelper._metrics.totalRequests}');
print('Average Latency: ${apiHelper._metrics.averageLatency} ms');