Flutter插件ok_ziggy的介绍与使用

Flutter插件ok_ziggy的介绍与使用

在本指南中，我们将探讨如何在Flutter项目中使用插件ok_ziggy。ok_ziggy是一个动态代理，通过OpenAPI规范实现与多个服务的无缝交互。

安装此工具

确保已经安装了Dart。你可以根据以下链接中的说明进行安装：

https://dart.dev/get-dart

安装完成后，你可以通过以下命令安装ok_ziggy和ok_ziggy_tools：

dart pub global activate ok_ziggy_tools
dart pub global activate ok_ziggy

初始化服务器项目

进入你想要初始化聊天机器人服务器的目录，并运行以下命令：

zigt init

这将在数据目录下生成你的服务器文件。对于文件的详细解释，可以查看工具项目的文档：

https://github.com/sisbell/ok-ziggy-tools

运行聊天机器人服务器

运行Ok Ziggy服务器，使用以下命令：

ziggy start

如果需要配置启动参数，可以使用以下命令：

ziggy start --help

开发自己的插件并安装

现在，我们需要通过开发自己的插件来扩展ok_ziggy的功能。插件的安装过程如下图所示：

示例代码

我们来看一个简单的示例代码，演示如何在Flutter项目中使用ok_ziggy插件。首先，确保你的项目中已经添加了ok_ziggy依赖。可以在pubspec.yaml文件中添加以下依赖：

dependencies:
  ok_ziggy: ^1.0.0

然后，通过以下代码片段调用ok_ziggy插件：

import 'package:flutter/material.dart';
import 'package:ok_ziggy/ok_ziggy.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Ok Ziggy Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              // 调用Ok Ziggy插件
              final response = await OkZiggy().callService('api.speak.com', '/v1/speak');
              print('Response from api.speak.com: $response');
            },
            child: Text('Call Service'),
          ),
        ),
      ),
    );
  }
}

更新新服务

sample-domains.json 文件中只包含了三个服务，但你可以添加更多的服务。例如：

[
  "api.speak.com",
  "trip.com",
  "server.shop.app"
]

你也可以从以下站点选择更多服务：

https://github.com/sisbell/chatgpt-plugin-store

在添加任何服务之前，请确保在 manifest 文件中没有认证需求。此外，需要注意的是，并非所有服务都能按预期工作，因此需要进行测试。

{
  "auth": {
    "type": "none"
  }
}

添加后，需要重新生成目录：

zigt create -i data/sample-domains.json

然后将新文件复制到目录中：

zigt copy

重启服务器：

ziggy start