SuperGlue 数据连接器安装与配置指南

SuperGlue 数据连接器安装与配置指南

superglue superglue translates data from external systems into exactly the format you need. 项目地址: https://gitcode.com/gh_mirrors/supe/superglue

1. 项目基础介绍

SuperGlue 是一个自修复的开源数据连接器，旨在简化与复杂或老旧 API 的交互。它可以作为代理部署在用户和 API 之间，确保用户总是以期望的格式接收所需数据。SuperGlue 通过自动生成 API 配置、处理分页、认证和错误重试，以及使用 JSONata 表达式将响应数据转换成用户定义的精确格式来实现这一功能。

主要编程语言：TypeScript

2. 项目使用的关键技术和框架

• 大型语言模型：用于自动生成数据转换。
• API 代理：实时拦截和转换 API 响应。
• 文件处理：支持处理 CSV、JSON、XML 等多种文件格式，并自动解压缩。
• 模式验证：确保数据与指定模式相符合。
• 灵活的认证方式：支持包括头认证、API 密钥、OAuth 在内的多种认证方法。
• 智能分页：自动处理不同的分页样式。
• 缓存和重试逻辑：内置缓存和可配置的重试策略。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保你的系统中已安装 Docker。
• 准备一个用于 SuperGlue 运行的环境变量文件 .env。

安装步骤

步骤 1：拉取 Docker 镜像

打开终端（或命令提示符），执行以下命令来拉取 SuperGlue 的 Docker 镜像：

docker pull superglueai/superglue

步骤 2：创建环境变量文件

在 SuperGlue 的根目录下创建一个 .env 文件，该文件应包含至少以下内容：

# .env 文件内容示例
API_KEY=your_api_key

请替换 your_api_key 为你的实际 API 密钥。

步骤 3：启动 SuperGlue 服务器

在终端执行以下命令来启动 SuperGlue 服务器：

docker run -d \
--name superglue \
--env-file .env \
-p 3000:3000 \
-p 3001:3001 \
superglueai/superglue

这个命令会创建一个名为 superglue 的容器，并映射端口 3000 和 3001 到宿主机的相同端口。

步骤 4：验证安装

验证 SuperGlue 是否正常运行的两种方法：

• 使用 curl 命令：

curl http://localhost:3000/health

如果返回 OK，则表示安装成功。

• 打开浏览器并访问：

http://localhost:3000/?token=your-auth-token

将 your-auth-token 替换为你的实际授权令牌。

步骤 5：配置和使用 SuperGlue

SuperGlue 提供了一个 dashboard，你可以通过以下 URL 访问并进行配置：

http://localhost:3001/

使用 SuperGlue 的客户端进行 API 调用时，你需要安装客户端 SDK：

npm install @superglue/client

然后，你可以按照 SuperGlue 的文档来创建配置对象，并通过客户端调用 API。

以上步骤将帮助你成功安装和配置 SuperGlue 数据连接器。如果你在安装过程中遇到任何问题，可以查看项目的 GitHub Issues 或加入社区寻求帮助。

superglue superglue translates data from external systems into exactly the format you need. 项目地址: https://gitcode.com/gh_mirrors/supe/superglue