Flutter网络请求插件rest_api_helper的使用

rest_api_helper 是一个用于简化 Flutter 中网络请求的插件。它提供了一种简单的方式来执行 HTTP 请求，并处理响应。以下是如何使用 rest_api_helper 插件的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 rest_api_helper 依赖：

dependencies:
  flutter:
    sdk: flutter
  rest_api_helper: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

2. 导入包

在你的 Dart 文件中导入 rest_api_helper：

import 'package:rest_api_helper/rest_api_helper.dart';

3. 创建 RestApiHelper 实例

你可以通过以下方式创建一个 RestApiHelper 实例：

final apiHelper = RestApiHelper(baseUrl: 'https://jsonplaceholder.typicode.com');

baseUrl 是你的 API 的基础 URL。

4. 执行网络请求

rest_api_helper 提供了多种方法来执行 HTTP 请求，如 get, post, put, delete 等。

GET 请求

Future<void> fetchData() async {
  try {
    final response = await apiHelper.get('/posts');
    print(response);
  } catch (e) {
    print('Error: $e');
  }
}

POST 请求

Future<void> postData() async {
  try {
    final response = await apiHelper.post('/posts', body: {
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    });
    print(response);
  } catch (e) {
    print('Error: $e');
  }
}

PUT 请求

Future<void> updateData() async {
  try {
    final response = await apiHelper.put('/posts/1', body: {
      'id': 1,
      'title': 'foo',
      'body': 'bar',
      'userId': 1,
    });
    print(response);
  } catch (e) {
    print('Error: $e');
  }
}

DELETE 请求

Future<void> deleteData() async {
  try {
    final response = await apiHelper.delete('/posts/1');
    print(response);
  } catch (e) {
    print('Error: $e');
  }
}

5. 处理响应

rest_api_helper 会自动将响应解析为 Map<String, dynamic> 或 List<dynamic>，你可以直接使用这些数据。

6. 错误处理

rest_api_helper 会自动处理常见的网络错误，并在请求失败时抛出异常。你可以使用 try-catch 块来捕获并处理这些错误。

7. 自定义请求头

你可以在请求中添加自定义的请求头：

final response = await apiHelper.get('/posts', headers: {
  'Authorization': 'Bearer your_token',
});

8. 其他配置

rest_api_helper 还支持其他配置，如超时设置、请求拦截器等。你可以根据需要进行配置。

示例代码

以下是一个完整的示例，展示了如何使用 rest_api_helper 进行 GET 请求：

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

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('RestApiHelper Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: fetchData,
            child: Text('Fetch Data'),
          ),
        ),
      ),
    );
  }

  Future<void> fetchData() async {
    final apiHelper = RestApiHelper(baseUrl: 'https://jsonplaceholder.typicode.com');
    try {
      final response = await apiHelper.get('/posts');
      print(response);
    } catch (e) {
      print('Error: $e');
    }
  }
}