nj_api_service 是一个用于 Flutter 的 API 服务集成插件，它简化了与后端 API 的交互过程。通过这个插件，你可以轻松地发送 HTTP 请求、处理响应、管理错误等。以下是如何使用 nj_api_service 插件的详细步骤。

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 nj_api_service 插件的依赖。

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

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

2. 初始化 API 服务

在你的 Flutter 应用中，首先需要初始化 nj_api_service。通常你可以在 main.dart 文件中进行初始化。

import 'package:nj_api_service/nj_api_service.dart';

void main() {
  // 初始化 API 服务
  NjApiService.initialize(
    baseUrl: 'https://your-api-endpoint.com', // 你的 API 基础 URL
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer your_token', // 如果需要认证
    },
  );

  runApp(MyApp());
}

3. 发送 GET 请求

你可以使用 NjApiService 来发送 GET 请求并获取数据。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> fetchData() async {
  try {
    final response = await NjApiService.get('/endpoint');
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}

4. 发送 POST 请求

发送 POST 请求与 GET 请求类似，只是需要传递请求体。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> postData() async {
  try {
    final response = await NjApiService.post(
      '/endpoint',
      data: {
        'key1': 'value1',
        'key2': 'value2',
      },
    );
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}

5. 发送 PUT 和 DELETE 请求

PUT 和 DELETE 请求的使用方式与 POST 请求类似。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> updateData() async {
  try {
    final response = await NjApiService.put(
      '/endpoint',
      data: {
        'key1': 'new_value1',
        'key2': 'new_value2',
      },
    );
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}

Future<void> deleteData() async {
  try {
    final response = await NjApiService.delete('/endpoint');
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}

6. 处理错误和异常

nj_api_service 会自动处理一些常见的错误和异常，但你也可以在代码中手动处理。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> fetchData() async {
  try {
    final response = await NjApiService.get('/endpoint');
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } on NjApiException catch (e) {
    // 处理 API 异常
    print('API Exception: ${e.message}');
  } catch (e) {
    // 处理其他异常
    print('Exception: $e');
  }
}

7. 自定义请求头

你可以在每次请求时自定义请求头。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> fetchDataWithCustomHeaders() async {
  try {
    final response = await NjApiService.get(
      '/endpoint',
      headers: {
        'Custom-Header': 'CustomValue',
      },
    );
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}

8. 使用拦截器

nj_api_service 支持拦截器，你可以在请求发送前或响应接收后进行一些操作。

import 'package:nj_api_service/nj_api_service.dart';

void main() {
  NjApiService.initialize(
    baseUrl: 'https://your-api-endpoint.com',
    interceptors: [
      (request) {
        // 在请求发送前进行操作
        print('Request: ${request.url}');
        return request;
      },
      (response) {
        // 在响应接收后进行操作
        print('Response: ${response.statusCode}');
        return response;
      },
    ],
  );

  runApp(MyApp());
}

9. 使用缓存

nj_api_service 还支持缓存功能，你可以通过设置缓存策略来缓存响应数据。

import 'package:nj_api_service/nj_api_service.dart';

Future<void> fetchDataWithCache() async {
  try {
    final response = await NjApiService.get(
      '/endpoint',
      cachePolicy: CachePolicy.cacheFirst, // 使用缓存策略
    );
    if (response.statusCode == 200) {
      // 处理成功响应
      print('Data: ${response.data}');
    } else {
      // 处理错误响应
      print('Error: ${response.statusCode}');
    }
  } catch (e) {
    // 处理异常
    print('Exception: $e');
  }
}