Flutter OpenAPI集成插件openapi_infrastructure的使用

Flutter OpenAPI集成插件openapi_infrastructure的使用

特性

• 提供一个名为 NetworkingClientBase 的接口，包含一个 sendRequest 方法。
• 通过 HttpRequestBase 抽象各种类型的请求（包括多部分请求），并通过 HttpResponseBase 抽象响应。
• UndefinedWrapper<T> 使用扩展类型来包装未定义的值，这些值不同于可空值：
  • 可空值可以序列化为 JSON 的 null。
  • 未定义值不应在 JSON 映射中出现。

开始使用

首先，在你的 pubspec.yaml 文件中添加依赖：

dart pub add openapi_infrastructure

完整示例代码

// ignore_for_file: unused_local_variable

import 'dart:convert';

import 'package:cross_file/cross_file.dart';
import 'package:http_parser/http_parser.dart';
import 'package:openapi_infrastructure/openapi_infrastructure.dart';
import 'package:test/test.dart';

class MyNetworkingClient extends NetworkingClientBase {
  [@override](/user/override)
  Future<HttpResponseBase> sendRequest(HttpRequestBase request) {
    // 实现网络客户端逻辑，可以使用 package:http 或 package:dio
    // 如果需要额外定制，可以通过 [request.context] 访问上下文信息。
    throw UnimplementedError();
  }
}

void main() async {
  final client = MyNetworkingClient();
  final endpoint = Uri.https('example.com', '/endpoint');

  // 创建一个空请求
  final empty = HttpRequestBase.empty(
    url: endpoint,
    method: HttpRequestBase.getMethod,
  );

  // 创建一个带有内存体的 POST 请求
  final post = HttpRequestBase.memory(
    url: endpoint,
    method: HttpRequestBase.postMethod,
    bodyBytes: utf8.encode('hello world'),
    headers: {
      'content-type': MediaType('text', 'plain', {'charset': 'utf8'}).toString(),
    },
  );

  // 创建一个流式 POST 请求
  final postStream = HttpRequestBase.stream(
    url: endpoint,
    method: HttpRequestBase.postMethod,
    bodyBytesStream: Stream.value([1, 2, 3]),
    headers: {
      'content-type': MediaType('application', 'octet-stream').toString(),
    },
  );

  // 创建一个多部分请求
  final multipart = HttpRequestBase.multipart(
    url: endpoint,
    method: 'POST',
    parts: [
      HttpPacketMixin.memory(
        bodyBytes: utf8.encode('hello world part'),
        headers: {
          'content-type': MediaType('text', 'plain', {'charset': 'utf8'}).toString(),
        },
      ),
      HttpPacketMixin.stream(
        bodyBytesStream: Stream.fromIterable([
          [1, 2, 3],
          [4, 5],
        ]),
        contentLength: 5,
        headers: {
          'content-type': MediaType('application', 'octet-stream').toString(),
        },
      ),
    ],
  );

  // 可以修改多部分请求
  multipart.parts.add(HttpPacketMixin.empty());
  multipart.parts.add(HttpPacketMixin.stream(
    bodyBytesStream: Stream.value([1, 2, 3]),
  ));

  // 创建一个表单数据请求
  final file = XFile('test/test-file.txt');
  final formData = HttpRequestBase.formData(
    url: endpoint,
    method: HttpRequestBase.postMethod,
    fields: {
      'name': 'my name',
    },
    files: [
      MultiPartFormDataFileHttpPacket(
        field: 'files',
        fileName: file.name,
        fileSize: await file.length(),
        mimeType: file.mimeType,
        bodyBytesStream: file.openRead(),
      ),
    ],
  );

  // 可以修改表单数据请求
  formData.fields['other-name'] = 'my other name';
  formData.files.add(MultiPartFormDataFileHttpPacket(
    field: 'files',
    fileName: 'whatever.bin',
    fileSize: 7,
    mimeType: 'application/octet-stream',
    bodyBytesStream: Stream.fromIterable(
      [
        [1, 2, 3],
        [4, 5, 6, 7],
      ],
    ),
  ));

  // 发送请求
  final response = await client.sendRequest(formData);

  // 访问响应头
  print(response.headers);

  // 将响应体解码为字符串
  final responseBodyAsString = utf8.decodeStream(response.bodyBytesStream);
}