Flutter API集成插件api_provider的使用

概述

API Provider Flutter 插件是一个强大且灵活的 Flutter 插件，旨在简化在 Flutter 应用程序中集成 API 的过程。该插件采用简单直接的方法进行 API 调用、处理响应并管理状态，使你能够专注于构建稳健高效的移动应用。

特性

• 易于集成：通过少量设置即可快速将 API 调用集成到你的 Flutter 应用程序中。
• 状态管理：轻松管理 API 调用的状态，并处理加载、成功和错误状态。
• 可定制性：可以自定义请求头、参数和其他配置。
• 错误处理：流线型的错误处理机制，便于识别和管理 API 调用问题。
• 并发支持：支持并发 API 调用，确保最佳性能。
• 可扩展性：通过无缝管理多个 API，轻松扩展应用程序。

开始使用

安装

要使用 API Provider Flutter 插件，请在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  api_provider: ^1.0.5

使用方法

1. 导入包

import 'package:api_provider/api_provider.dart';

2. 创建一个 ApiProvider 实例

ApiProvider apiProvider = ApiProvider(baseUrl: 'https://api.example.com/');

3. 进行 API 调用

apiProvider.get('your api path without url')
  .then((response) {
    // 处理成功情况
  })
  .catchError((error) {
    // 处理错误
  });

配置

你可以为每个 API 调用提供认证令牌，使用 persistToken 函数：

await apiProvider.persistToken(token: 'your Api token');

await apiProvider.deleteAuthToken();

await apiProvider.updateAuthToken(updatedToken: 'your refresh token');

await apiProvider.hasAuthToken();

你还可以扩展 BaseProvider 类并通过传递 BaseApiClient 从 ApiProvider 实例来调用 API：

class AlertProvider extends BaseProvider {
  AlertProvider({required BaseApiClient httpClient, required String name}) : super(httpClient: httpClient, name: name);

  Future<dynamic> getData() async {
    var response = await get('your api path without base url');
    return response;
  }
}

示例代码

以下是完整的示例代码：

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

ApiProvider apiProvider = ApiProvider(baseUrl: 'http://api.example.com/');

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  bool isLoggedIn = false;
  String? authToken = '';
  String? responseData = '';

  [@override](/user/override)
  void initState() {
    super.initState();
    _getTokenState();
  }

  _getTokenState() async {
    String? token = await apiProvider.hasAuthToken();
    setState(() {
      authToken = token;
      isLoggedIn = token != null ? true : false;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: SingleChildScrollView(
          child: Column(
            children: [
              Text(isLoggedIn.toString()),
              Text(authToken.toString()),
              const SizedBox(height: 10,),
              Text(responseData.toString()),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () async {
            var response = await apiProvider.post('api/v1/Data/get', data: {"page": 0, "pageSize": 10});
            setState(() {
              responseData = response.data['data'].toString();
            });
          },
          child: const Icon(Icons.network_cell),
        ),
      ),
    );
  }
}