Flutter运行时密钥生成插件runtime_keygen_openapi的使用

Flutter运行时密钥生成插件runtime_keygen_openapi的使用

简介

runtime_keygen_openapi 是一个基于 Flutter 的 Dart 包，用于与 Keygen API 进行交互。该 API 遵循 REST 原则，所有请求必须通过 TLS/SSL 进行加密。出于安全原因，仅支持 TLS 1.2。API 请求和响应主体（包括错误）均以 JSON 格式编码。

此包由 OpenAPI Generator 项目自动生成，版本为 1.0.0，构建包为 org.openapitools.codegen.languages.DartClientCodegen。更多详细信息可访问 Keygen 官方网站。

要求

• Dart 2.12 或更高版本

安装与使用

从 GitHub 安装

如果此包已发布到 GitHub，则可以在 pubspec.yaml 文件中添加以下依赖：

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

本地安装

若要使用本地路径安装此包，则在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  runtime_keygen_openapi:
    path: /path/to/runtime_keygen_openapi

测试

测试部分尚未完成，请参考官方文档进一步完善。

入门指南

请按照上述安装步骤完成后，运行以下代码：

import 'package:runtime_keygen_openapi/api.dart'; // 导入 API 模块

// 配置 HTTP Bearer 认证（此处需根据实际情况设置）
// Case 1: 使用字符串令牌
// defaultApiClient.getAuthentication<HttpBearerAuth>('BearerToken').setAccessToken('YOUR_ACCESS_TOKEN');

// Case 2: 使用生成令牌的函数
// String yourTokenGeneratorFunction() { ... }
// defaultApiClient.getAuthentication<HttpBearerAuth>('BearerToken').setAccessToken(yourTokenGeneratorFunction());

final api_instance = EntitlementsApi(); // 创建 EntitlementsApi 实例
final account = 'account_example'; // 替换为你的 Keygen 账户标识符或 slug
final createEntitlementRequest = CreateEntitlementRequest(); // 创建请求对象

try {
  final result = api_instance.createEntitlement(account, createEntitlementRequest);
  print(result); // 打印结果
} catch (e) {
  print('Exception when calling EntitlementsApi->createEntitlement: $e\n'); // 捕获异常并打印
}

API 文档

EntitlementsApi

以下是一些关键 API 方法及其描述：

授权文档

BasicAuth

• 类型: HTTP Basic 身份验证

BearerToken

• 类型: HTTP Bearer 身份验证

示例代码完整 DEMO

以下是一个完整的 Flutter 示例代码，展示如何使用 runtime_keygen_openapi 插件创建和获取许可项：

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

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

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

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

class _KeygenDemoPageState extends State<KeygenDemoPage> {
  String accountID = ''; // 替换为你的账户 ID
  CreateEntitlementRequest createEntitlementRequest = CreateEntitlementRequest();

  Future<void> createAndRetrieveEntitlement() async {
    try {
      // 初始化 API 实例
      final api_instance = EntitlementsApi();

      // 配置 Bearer Token 认证
      defaultApiClient.getAuthentication<HttpBearerAuth>('BearerToken').setAccessToken('YOUR_ACCESS_TOKEN');

      // 创建许可项
      final createResult = await api_instance.createEntitlement(accountID, createEntitlementRequest);
      print('Create Entitlement Result: $createResult');

      // 获取许可项列表
      final listResult = await api_instance.listEntitlements(accountID);
      print('List Entitlements Result: $listResult');

      // 获取单个许可项
      final retrieveResult = await api_instance.retrieveEntitlement(accountID, 'ENTITLEMENT_ID');
      print('Retrieve Entitlement Result: $retrieveResult');
    } catch (e) {
      print('Exception: $e');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('runtime_keygen_openapi 使用示例'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: createAndRetrieveEntitlement,
          child: Text('创建并获取许可项'),
        ),
      ),
    );
  }
}