1Password Connect SDK for Go 使用教程

1. 项目目录结构及介绍

1Password Connect SDK for Go 的目录结构如下：

connect-sdk-go/
├── .github/             # GitHub 工作流文件
├── connect/             # SDK 主要逻辑实现
├── onepassword/        # 1Password 相关模型和工具
├── scripts/             # 构建和发布脚本
├── .gitignore           # Git 忽略文件
├── CHANGELOG.md         # 更新日志
├── LICENSE              # 开源协议文件
├── Makefile             # Makefile 文件
├── README.md            # 项目说明文件
├── USAGE.md             # 使用说明文件
├── go.mod               # Go 模块配置文件
└── go.sum               # Go 模块依赖校验文件

• .github/: 包含 GitHub Actions 工作流，用于自动化处理代码提交、发布等流程。
• connect/: 包含 SDK 的主要逻辑代码，如客户端实现、API 调用等。
• onepassword/: 包含与 1Password 相关的模型定义和工具函数。
• scripts/: 包含构建和发布项目的脚本文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目的版本更新和变更历史。
• LICENSE: 项目使用的开源协议（MIT）。
• Makefile: 用于构建和发布项目的 Makefile 文件。
• README.md: 项目的说明文件，介绍项目的功能和用法。
• USAGE.md: 详细的使用说明，包含代码示例。
• go.mod: Go 模块的配置文件，管理项目的依赖。
• go.sum: 校验项目依赖的文件，确保依赖的完整性和一致性。

2. 项目的启动文件介绍

在 connect-sdk-go 目录下，并没有一个明确的启动文件，因为这是一个 SDK 项目，旨在被其他 Go 项目导入和使用。开发者通常会在自己的项目中导入这个 SDK，并创建 NewClientFromEnvironment 实例来使用它。

以下是一个简单的例子：

package main

import (
    "github.com/1Password/connect-sdk-go/connect"
    "log"
)

func main() {
    client := connect.NewClientFromEnvironment()
    // 这里可以进行 API 调用等操作
}

在这个例子中，NewClientFromEnvironment 函数会从环境变量中读取配置信息，创建一个客户端实例。

3. 项目的配置文件介绍

该 SDK 项目主要通过环境变量进行配置。需要设置以下环境变量：

• OP_CONNECT_HOST: 1Password Connect 服务的主机地址。
• OP_CONNECT_TOKEN: 认证 token，用于验证客户端的权限。

你可以在你的 Go 应用程序中通过以下方式设置环境变量：

import (
    "os"
    "github.com/1Password/connect-sdk-go/connect"
)

func main() {
    os.Setenv("OP_CONNECT_HOST", "your-connect-host")
    os.Setenv("OP_CONNECT_TOKEN", "your-connect-token")

    client := connect.NewClientFromEnvironment()
    // 这里可以进行 API 调用等操作
}

确保在调用任何 SDK 功能之前设置好这些环境变量。如果你的应用程序在容器或其他环境中运行，你可能需要确保这些环境变量在运行环境中正确设置。