Flutter轻量级REST API请求插件minimal_rest的使用

Flutter轻量级REST API请求插件minimal_rest的使用

标题

Flutter轻量级REST API请求插件minimal_rest的使用

内容

如果你喜欢Either<L, R>数据类型来自dartz包，并且厌倦了在Either<L, R>中编写消费REST API的模板代码，那么这个包就是为你准备的。

MinRest充当一个REST客户端，并将数据返回为你的DataModel或Entity，无论你想要哪种对象。

特性

• 制作各种http请求
• 它通过制作http请求返回你的DataModel，并返回Either<YourModel, Error>

开始使用

你需要初始化MinRest单例对象并设置基URL。让我们在main.dart文件中进行初始化。

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  ...
  MinRest.init("https://jsonplaceholder.typicode.com/todos/1");
  ...
  runApp(Main());
}

发送GET请求

1. 您自己的DataModel类 假设我们有一个名为UserModel的数据模型类。

class UserModel {
  final String name;
  final String email;

  UserModel({required this.name, required this.email});

  factory UserModel.fromJson(Map<String, dynamic> json) {
    return UserModel(
      name: json['name'],
      email: json['email'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'email': email,
    };
  }
}

1. 发送API调用并获取Either<MinRestError, UserModel>

final userOrError = await MinRest().getErrorOr<UserModel>(
  "/path_to_user_data",
  (json) =&gt UserModel.fromJson(json),
);

1. 折叠并使用数据 现在你可以像任何Either<L, R>对象一样使用userOrError。 让我们折叠userOrError并打印用户的名字和电子邮件（如果请求和响应成功）或者打印错误状态码和消息（如果请求失败）。

userOrError.fold(
  (error) => print("Error: ${error.code} - ${error.message}"),
  (user) => print("User: ${user.name} - ${user.email}"),
);

使用

如何使用MinRest

1. GET请求

final userOrError = await MinRest().getErrorOr<UserModel>(
  "/path_to_user_data",
  (json) =&gt; UserModel.fromJson(json),
  token: token.accessToken,
);

1. POST请求

final postData = await MinRest().postErrorOr<UserModel>(
  "/path_to_user_data",
  userModel.toJson(),
  (json) =&gt; UserModel.fromJson(json),
  token: token.accessToken,
);

1. PATCH请求

final patchData = MinRest().patchErrorOr<UserModel>(
  uri: "/auth/update-profile",
  data: userModel.toJson(),
  deSerializer: (json) =&gt; UserModel.fromJson(json),
  errorDeserializer: (json) =&gt; AppError.fromJson(json),
  token: token.accessToken,
);

1. DELETE请求

final deleteData = MinRest().deleteErrorOr(
  uri: "/auth/delete-account",
  deSerializer: (json) => RestResponseNoEntity.fromJson(json),
  errorDeserializer: (json) => AppError.fromJson(json),
  token: token.accessToken,
);

注意

AppError是您的自定义ErrorModel，稍后其他方法（如Get和Post方法）也将实现此功能，当前Get和Post方法只返回MinRestError。

示例代码

import 'package:minimal_rest/minimal_rest.dart';

class UserModel {
  final String name;
  final String email;

  UserModel({required this.name, required this.email});

  factory UserModel.fromJson(Map<String, dynamic> json) {
    return UserModel(
      name: json['name'],
      email: json['email'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'email': email,
    };
  }
}

Future&lt;void&gt; main() async {
  // 初始化 MinRest
  MinRest.init("https://jsonplaceholder.typicode.com");

  // 发送 GET 请求
  final tokenOrError = await MinRest().getErrorOr&lt;UserModel&gt;(
    "/path_to_user_data",
    (json) =&gt; UserModel.fromJson(json),
  );

  // 处理结果
  tokenOrError.fold(
    (error) =&gt; print("Error: ${error.code} - ${error.message}"),
    (user) =&gt; print("User: ${user.name} - ${user.email}"),
  );

  // 发送 POST 请求
  final postData = await MinRest().postErrorOr&lt;UserModel&gt;(
    "/path_to_user_data",
    {
      "name": "John Doe",
      "email": "example@email.com",
    },
    (json) =&gt; UserModel.fromJson(json),
  );
}