Flutter OpenAPI客户端代理插件openapi_client_delegates的使用

开始使用

使用此库来打印由openapi生成的API响应。

使用方法

PrintingClientDelegate

PrintingClientDelegate用于打印API请求日志。

ApiClient apiClient = ApiClient(
  basePath: 'Config.url',
  apiClientDelegate: PrintingClientDelegate(
    onResponse: (String requestLog) => print(requestLog), // 打印请求日志
    logLevels: {
      'a/call/you/dont/want/to/log/like/file/upload': LogLevel.none, // 不记录特定API调用的日志
      'a/frequent/call': LogLevel.url, // 只记录特定API调用的URL
    },
  ),
);

MockClientDelegate

MockClientDelegate用于模拟API响应。

const Map<String, String> responseMap = {
  '/auth/login': """
  {
    "success": true,
    "message": "SUCCESS",
    "data": {
      "accessToken": "908d1be3-a2ce-46b2-9548-edc435b736e9"
    }
  }""", 
  '/some-other-endpoint': """some-other-response""",
};

ApiClient apiClient = ApiClient(
  basePath: Config.url,
  apiClientDelegate: MockClientDelegate(
    responseMap: responseMap,
    onResponse: (String requestLog) => print(requestLog), // 打印请求日志
  ),
);

完整示例代码

以下是完整的示例代码，展示了如何在Flutter应用中使用openapi_client_delegates插件。

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  // 这个小部件是你的应用的根。
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  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>[
            Text(
              '你已经点击按钮次数:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}