Flutter插件simp_api的特性与使用

Flutter插件simp_api的特性与使用

simp_api 是一个用于在 Flutter 应用中使用 RESTful API 的简单且易于使用的库。它提供了定义 API 路由和处理 HTTP 请求与响应的简单接口。

通过 simp_api，你可以轻松地定义你的 API 路由、指定 HTTP 方法，并使用函数来处理传入的请求并返回响应。该库还包括处理查询参数、请求头和解析 JSON 负载的工具。

simp_api 设计得轻量且易于使用，非常适合小型到中型项目。此外，它支持同步和异步处理请求，允许你选择最适合你的应用的方法。

总之，如果你正在构建一个需要简单直接的方式来定义和处理 RESTful API 的 Dart 或 Flutter 应用，simp_api 值得一试。

Flutter插件simp_api的特性

• 发送 HTTP 请求
• 上传图片
• 上传文件
• 处理 HTTP 异常

安装

dependencies:
  simp_api: ^<latest_version>

使用

1. 发送 HTTP 请求

创建一个 SimpApi 实例

final simp = SimpApi.instance;

调用 sendRequest 方法发送 HTTP 请求

final res = await simp.sendRequest(
    requestType: RequestType.GET, // 请求类型
    url: 'https://catfact.ninja/fact', // 请求地址
);

注意：header 和 body 参数是可选的。如果 header 为空，它将默认为：

final Map<String, String> _header = {
    'Content-type': 'application/json',
    'Accept': 'application/json',
    'Access-Control-Allow-Origin': '*',
};

注意：requestType 是一个枚举类型：

enum RequestType {GET, PUT, POST, DELETE}

2. 上传图片

调用 uploadImage 方法上传图片

final res = await api.uploadImage(
  filesRequestType: FilesRequestType.PUT, // 文件请求类型
  url: '', // 请求地址
  imageFile: File('image_path'), // 图片文件路径
);

注意：filesRequestType 是一个枚举类型：

enum FilesRequestType {PUT, PATCH}

3. 上传文件

调用 uploadFiles 方法上传文件

final res = await api.uploadFiles(
  filesRequestType: FilesRequestType.PUT, // 文件请求类型
  url: '', // 请求地址
  files: [
    File('file1_path'), // 文件1路径
    File('file2_path'), // 文件2路径
    File('file3_path'), // 文件3路径
  ]
);

注意：filesRequestType 是一个枚举类型：

enum FilesRequestType {PUT, PATCH}

4. 处理 HTTP 异常

SimpApi 将处理所有异常，并给你一个简单的描述说明发生了什么问题。

on UnauthorisedException {
  throw UnauthorisedException('Check the requested URL');
} on SocketException {
  throw FetchDataException('Check your internet connection or a typo in $url');
} catch (error) {
  debugPrint('EasyApi error @ $url : $error');
}

Bug/需求反馈

如果您遇到任何问题，请随时提出。如果您觉得库缺少某些功能，请在 GitHub 上提交一个请求。也欢迎提交 Pull Request。

示例代码

import 'dart:io';

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  final simp = SimpApi.instance;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            TextButton(
              onPressed: onButtonTap,
              child: const Text('Make HTTP request!'),
            ),
            TextButton(
              onPressed: onImageButtonTap,
              child: const Text('Upload Image!'),
            ),
            TextButton(
              onPressed: onFilesButtonTap,
              child: const Text('Upload files!'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }

  Future<void> onButtonTap() async {
    final res = await simp.sendRequest(
      requestType: RequestType.GET,
      url: 'https://catfact.ninja/fact',
    );

    if (res != null) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(
          behavior: SnackBarBehavior.floating,
          duration: const Duration(seconds: 2),
          content: Text(
            res.statusCode.toString(),
            textAlign: TextAlign.center,
          ),
        ),
      );
    }
  }

  Future<void> onImageButtonTap() async {
    final res = await simp.uploadImage(
      filesRequestType: FilesRequestType.PUT,
      url: '',
      imageFile: File('image_path'),
    );

    if (res != null) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(
          behavior: SnackBarBehavior.floating,
          duration: const Duration(seconds: 2),
          content: Text(
            res.statusCode.toString(),
            textAlign: TextAlign.center,
          ),
        ),
      );
    }
  }

  Future<void> onFilesButtonTap() async {
    final res = await simp.uploadFiles(
      filesRequestType: FilesRequestType.PUT,
      url: '',
      files: [
        File('file1_path'),
        File('file2_path'),
        File('file3_path'),
      ]
    );

    if (res != null) {
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(
          behavior: SnackBarBehavior.floating,
          duration: const Duration(seconds: 2),
          content: Text(
            res.statusCode.toString(),
            textAlign: TextAlign.center,
          ),
        ),
      );
    }
  }
}