Flutter通用API集成插件nex_common_api的使用

Flutter通用API集成插件nex_common_api的使用

开始使用

一个用于发送HTTP GET和POST请求的Dart类，支持可选的基于令牌的身份验证和API密钥。

特性

• 支持发送带有可选头部信息的HTTP GET和POST请求。
• 支持基于令牌的身份验证。
• 可以选择在请求中包含API密钥。

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  nex_common_api: <latest-version>

运行flutter pub get来安装依赖。

使用方法

导入类

首先，导入必要的包：

import 'dart:convert';
import 'package:http/http.dart' as http;
import 'path_to_api_methods/api_methods.dart';

示例代码

发送GET请求

发送基本的GET请求：

void main() async {
  try {
    var response = await ApiMethods().getMethod(url: "https://api.example.com/data");
    print(response);
  } catch (e) {
    print("Error: $e");
  }
}

带有令牌的GET请求

发送带有身份验证令牌的GET请求：

void main() async {
  try {
    var response = await ApiMethods().getMethodWithToken(
        url: "https://api.example.com/data",
        token: "your_token_here"
    );
    print(response);
  } catch (e) {
    print("Error: $e");
  }
}

发送POST请求

发送基本的POST请求：

void main() async {
  try {
    var response = await ApiMethods().postMethod(
        url: "https://api.example.com/data",
        body: jsonEncode({"key": "value"})
    );
    print(response);
  } catch (e) {
    print("Error: $e");
  }
}

带有令牌的POST请求

发送带有身份验证令牌的POST请求：

void main() async {
  try {
    var response = await ApiMethods().postMethodWithToken(
        url: "https://api.example.com/data",
        token: "your_token_here",
        body: jsonEncode({"key": "value"})
    );
    print(response);
  } catch (e) {
    print("Error: $e");
  }
}

完整示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中使用ApiMethods类：

import 'dart:convert';

import 'package:flutter/material.dart';
import 'package:nex_common_api/api_core/api_methods.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ApiMethods Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  ApiMethods apiMethods = ApiMethods();

  String _displayText = '';

  void _getData() async {
    try {
      var response = await apiMethods.getMethod(
        url: 'https://jsonplaceholder.typicode.com/posts/1',
      );

      setState(() {
        _displayText = jsonEncode(response);
      });
    } catch (e) {
      setState(() {
        _displayText = 'Error: $e';
      });
    }
  }

  void _postData() async {
    try {
      var response = await apiMethods.postMethod(
        url: 'https://jsonplaceholder.typicode.com/posts',
        body: jsonEncode({'title': 'foo', 'body': 'bar', 'userId': 1}),
      );

      setState(() {
        _displayText = jsonEncode(response);
      });
    } catch (e) {
      setState(() {
        _displayText = 'Error: $e';
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('ApiMethods Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: _getData,
              child: Text('GET Data'),
            ),
            ElevatedButton(
              onPressed: _postData,
              child: Text('POST Data'),
            ),
            SizedBox(height: 20),
            Text(
              'Response:',
              style: TextStyle(fontSize: 18, fontWeight: FontWeight.bold),
            ),
            SizedBox(height: 10),
            Expanded(
              child: SingleChildScrollView(
                child: Padding(
                  padding: EdgeInsets.all(10),
                  child: Text(
                    _displayText,
                    style: TextStyle(fontSize: 16),
                  ),
                ),
              ),
            ),
          ],
        ),
      ),
    );
  }
}