Flutter API调用插件 kd_api_call 的使用

kd_api_call 是一个基于 Future 的库，允许你轻松地进行简单的 HTTP 请求。它支持多平台，包括移动、桌面和浏览器。

目录

• 安装
• 初始化
• 使用方法
• 参数和响应日志
• 示例代码
• 功能和问题

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  kd_api_call: ^0.1.1

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

初始化

首先导入包：

import 'package:kd_api_call/kd_api_call.dart';

使用方法

你可以使用顶级函数来简化 HTTP 请求的发送。以下是一个简单的 GET 请求示例：

import 'package:kd_api_call/kd_api_call.dart';

APIRequestInfo requestInfo = APIRequestInfo(
    url: "https://jsonplaceholder.typicode.com/albums/1",
    requestType: HTTPRequestType.GET,
);

Response apiResponse = await ApiCall.instance.callService(requestInfo: requestInfo);

参数和响应日志

请求参数日志

Service Parameters
|-------------------------------------------------------------------------------------------------------------------------
| ApiType :- GET
| URL     :- https://jsonplaceholder.typicode.com/albums/1
| Header  :- {Content-Type: application/json}
| Params  :- null
|-------------------------------------------------------------------------------------------------------------------------

响应日志

Service Response
|--------------------------------------------------------------------------------------------------------------------------
| API        :- https://jsonplaceholder.typicode.com/albums/1
| StatusCode :- 200
| Message    :- {"userId": 1, "id": 1, "title": "quidem molestiae enim"}
|--------------------------------------------------------------------------------------------------------------------------

示例代码

以下是一个完整的示例应用，展示了如何使用 kd_api_call 插件从网络获取数据并显示在界面上。

import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
import 'package:kd_api_call/kd_api_call.dart';

void main() {
  // Run app...
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> {
  // Api response...
  http.Response? apiResponse;

  // Flag...
  bool _isLoading = false;

  [@override](/user/override)
  void initState() {
    super.initState();
    // Fetch data from internet...
    fetchData();
  }

  [@override](/user/override)
  Widget build(BuildContext context) => MaterialApp(
        home: Scaffold(
          // App bar...
          appBar: AppBar(
            title: const Text('Kd Api Call Example'),
          ),
          // Body...
          body: _buildBody(),
        ),
      );

  // Body...
  Widget _buildBody() => Center(
        child: _isLoading
            ? const CircularProgressIndicator.adaptive()
            : apiResponse == null
                ? const Text('Something went wrong!')
                : Text(apiResponse!.body),
      );

  // Fetch data from internet...
  Future<void> fetchData() async {
    try {
      // Start loading...
      if (mounted) {
        setState(() {
          _isLoading = true;
        });
      }
      // Api request info...
      APIRequestInfo requestInfo = APIRequestInfo(
        url: "https://jsonplaceholder.typicode.com/albums/1",
        requestType: HTTPRequestType.get,
      );

      // Call api...
      // Await the http get response, then decode the json-formatted response.
      apiResponse = await ApiCall.instance.callService(requestInfo: requestInfo);
    } on AppException catch (e) {
      // Show error in snack bar...
      ScaffoldMessenger.of(context).showSnackBar(
        SnackBar(
          content: Text(e.getMessage),
        ),
      );
    } catch (e) {
      // Show error in snack bar...
      ScaffoldMessenger.of(context).showSnackBar(
        const SnackBar(
          content: Text('Something went wrong!'),
        ),
      );
    } finally {
      // Stop loading...
      if (mounted) {
        setState(() {
          _isLoading = false;
        });
      }
    }
  }
}