Flutter API客户端插件tth_api_client的使用

tth_api_client

基于 OpenAPI 3.1 规范生成。

此 Dart 包由 OpenAPI Generator 项目自动生成：

• API 版本: 0.0.61
• 生成器版本: 7.6.0
• 构建包: org.openapitools.codegen.languages.DartClientCodegen
  更多相关信息，请访问 https://tutorhouse.co.uk

Requirements

Dart 2.12 或更高版本

Installation & 使用

GitHub

如果此 Dart 包发布在 GitHub 上，将以下依赖项添加到您的 pubspec.yaml 文件中：

dependencies:
  tth_api_client:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

若要在本地使用该包，请将其路径添加到您的 pubspec.yaml 文件中：

dependencies:
  tth_api_client:
    path: /path/to/tth_api_client

Tests

待完成。

Getting Started

请按照上述安装步骤操作后，运行以下代码示例：

import 'package:tth_api_client/api.dart';

// 配置 HTTP 基本身份验证: basicAuth
// defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME';
// defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

// 配置 API 密钥身份验证: tutorhouse_token_authentication
// defaultApiClient.getAuthentication<ApiKeyAuth>('tutorhouse_token_authentication').apiKey = 'YOUR_API_KEY';
// 如果需要设置前缀（例如 Bearer），取消注释以下行
// defaultApiClient.getAuthentication<ApiKeyAuth>('tutorhouse_token_authentication').apiKeyPrefix = 'Bearer';

final api_instance = ApiApi();

try {
  // 调用 GET 请求获取 Alevel 课程列表
  final result = await api_instance.apiV1AlevelCoursesList();
  print(result);
} catch (e) {
  print('Exception when calling ApiApi->apiV1AlevelCoursesList: $e\n');
}

Documentation for API Endpoints

所有 URI 相对于 http://localhost。

ApiApi 类方法示例

以下为部分 API 方法的示例代码：

final api_instance = ApiApi();

try {
  // 获取 Alevel 科目列表
  final subjectResult = await api_instance.apiV1AlevelSubjectsList();
  print(subjectResult);

  // 创建 Alevel 下载请求
  final downloadRequest = new DownloadRequest();
  final downloadResult = await api_instance.apiV1AlevelDownloadsCreate(downloadRequest);
  print(downloadResult);

  // 获取通知列表
  final notificationResult = await api_instance.apiV1NotificationsList();
  print(notificationResult);

  // 标记通知为已读
  final markReadRequest = new MarkReadRequest();
  final markReadResult = await api_instance.apiV1NotificationsMarkReadCreate(markReadRequest);
  print(markReadResult);

  // 获取未读通知数量
  final unreadCountResult = await api_instance.apiV1NotificationsUnreadCountRetrieve();
  print(unreadCountResult);

  // 获取可用性信息
  final availabilityResult = await api_instance.apiV2AvailabilityRetrieve();
  print(availabilityResult);

  // 获取客户预订信息
  final bookingResult = await api_instance.apiV2CustomerBookingsList();
  print(bookingResult);

  // 获取推送通知列表
  final pushNotificationResult = await api_instance.apiV2PushNotificationList();
  print(pushNotificationResult);

  // 获取教师预订时间表
  final tutorBookingResult = await api_instance.apiV2TutorBookingTimeList(tutorId);
  print(tutorBookingResult);

  // 获取教师卡片信息
  final tutorCardResult = await api_instance.apiV2TutorCardList();
  print(tutorCardResult);

  // 获取教师详细信息
  final tutorDetailResult = await api_instance.apiV2TutorRetrieve(userId);
  print(tutorDetailResult);
} catch (e) {
  print('Exception when calling API methods: $e\n');
}

Documentation for Models

以下是部分模型的定义示例：

class ACourse {
  String name;
  List<ACourseSubject> subjects;

  ACourse({required this.name, required this.subjects});
}

class Booking {
  int id;
  String status;
  DateTime startTime;
  DateTime endTime;

  Booking({
    required this.id,
    required this.status,
    required this.startTime,
    required this.endTime,
  });
}

Documentation for Authorization

定义了两种认证方式：

basicAuth

• 类型: HTTP 基本身份验证

tutorhouse_token_authentication

• 类型: API 密钥
• 密钥参数名称: Authorization
• 位置: HTTP 头部

Author

发送邮件至 aaron.yongdong@oktopi.ai

完整示例 Demo

以下是一个完整的 Flutter 应用程序示例，展示如何使用 tth_api_client 插件调用 API 并处理返回数据：

import 'package:flutter/material.dart';
import 'package:tth_api_client/api.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'tth_api_client Demo',
      home: HomePage(),
    );
  }
}

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

class _HomePageState extends State<HomePage> {
  late final ApiApi _apiInstance;
  List<Booking>? _bookings;
  bool _isLoading = true;

  [@override](/user/override)
  void initState() {
    super.initState();
    _apiInstance = ApiApi();
    fetchBookings();
  }

  Future<void> fetchBookings() async {
    try {
      final bookingsResult = await _apiInstance.apiV2CustomerBookingsList();
      setState(() {
        _bookings = bookingsResult;
        _isLoading = false;
      });
    } catch (e) {
      setState(() {
        _isLoading = false;
      });
      print('Error fetching bookings: $e');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('tth_api_client Demo'),
      ),
      body: _isLoading
          ? Center(child: CircularProgressIndicator())
          : ListView.builder(
              itemCount: _bookings?.length ?? 0,
              itemBuilder: (context, index) {
                final booking = _bookings![index];
                return ListTile(
                  title: Text(booking.status!),
                  subtitle: Text('${booking.startTime} - ${booking.endTime}'),
                  onTap: () {
                    Navigator.push(
                      context,
                      MaterialPageRoute(
                        builder: (context) => BookingDetailsPage(booking: booking),
                      ),
                    );
                  },
                );
              },
            ),
    );
  }
}

class BookingDetailsPage extends StatelessWidget {
  final Booking booking;

  const BookingDetailsPage({Key? key, required this.booking}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Booking Details'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [
            Text('ID: ${booking.id}'),
            Text('Status: ${booking.status}'),
            Text('Start Time: ${booking.startTime}'),
            Text('End Time: ${booking.endTime}'),
          ],
        ),
      ),
    );
  }
}