Flutter插件apiarist的介绍与使用方法

Apiarist介绍

AsyncValue 但用于REST API。

Dart/Flutter库用于与API交互，特别是REST API。

这个库的想法来源于Riverpod的AsyncValue。这个想法非常棒。对于像从设备存储读取数据这样的常见任务来说，它非常好用。但是，如果使用AsyncValue进行API调用时会遇到问题，因为它只能处理加载、数据和异常。如果你收到HTTP 400错误请求或HTTP 401未授权请求，你必须将错误响应塞入“data”或“error”，但这都不是理想的情况。

Apiarist引入了API响应对象（ApiResponse）的概念来更好地处理这些情况。

获取开始

安装方式如下：

flutter pub add apiarist

Flutter插件apiarist的使用

下面是一个使用ApiResponse的示例：

import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:logger/logger.dart';
import 'package:apiarist/apiarist.dart';

// 假设 MyModel 是你的模型类
class MyModel {
  final String FullName;
  MyModel({required this.FullName});
}

final Logger logger = Logger();

void main() {
  runApp(ProviderScope(child: MyApp()));
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Apiarist Example'),
        ),
        body: ApiExample(),
      ),
    );
  }
}

class ApiExample extends ConsumerWidget {
  [@override](/user/override)
  Widget build(BuildContext context, ScopedReader watch) {
    // 使用你的Provider获取ApiResponse
    ApiResponse<MyModel> apiResponse = watch(myModelProvider);

    return apiResponse.when(
      loading: () => Center(child: CircularProgressIndicator()), // 加载状态
      data: (myModel) => Text(myModel.FullName), // 数据状态
      error: (apiError) {
        logger.w("API Error: ${apiError.statusCode} - ${apiError.parsedBody()['errorDesc']}");
        return Center(child: Text("${apiError.statusCode} - ${apiError.parsedBody()['errorDesc']}")); // 错误状态
      },
      unauthorized: (apiError) => Navigator.of(context).pushReplacementNamed('/login'), // 未授权状态
      notFound: (apiError) => Center(child: Text("Sorry, we couldn't find that one")), // 未找到状态
      failure: (apiFailure) {
        logger.w("API Failure: ${apiFailure.error}\n${apiFailure.stackTrace}");
        return Center(child: Text("Request failed")); // 失败状态
      },
    );
  }
}