Apache OpenWhisk 客户端库 Go 版本安装与使用教程
1. 项目目录结构及介绍
Apache OpenWhisk 的 Go 客户端库(openwhisk-client-go
)主要目录结构如下:
whisk
目录:包含了与 OpenWhisk API 交互的主要包,如action
,entity
,trigger
, 等。test
目录:存放单元测试相关的代码。cmd
目录(如果有):可能包含一些命令行工具的实现。examples
目录:提供了使用示例。Makefile
和其他构建相关文件:用于构建和测试项目。
这些文件夹和文件共同构成了一个完整的 Go 包,允许开发者在 Go 应用中调用 OpenWhisk API。
2. 项目启动文件介绍
在 openwhisk-client-go
中没有特定的启动文件,因为它是一个库而非独立的应用程序。通常,你需要在你的 Go 项目中导入这个库来创建客户端实例并进行操作。例如,以下是如何导入和初始化客户端的示例:
import (
"github.com/apache/openwhisk-client-go/whisk"
)
func main() {
client, err := whisk.NewClient(http.DefaultClient, nil)
// 处理错误...
}
这里,whisk.NewClient()
创建了 OpenWhisk 客户端对象,你可以通过它来调用各种 OpenWhisk API 方法。
3. 项目的配置文件介绍
配置文件名为 wskprop
,它定义了访问 OpenWhisk 服务所需的参数。此文件不包含在项目源代码中,而是由使用者在其工作环境中设置。一般来说,wskprop
文件应包含以下字段:
APIHOST
: OpenWhisk API 托管的主机名。APIVERSION
: API 的版本号。NAMESPACE
: 使用的工作空间或命名空间。AUTH
: 认证令牌。
当你在 Go 应用中使用 openwhisk-client-go
时,如果没有指定配置,该库将尝试自动加载环境变量中的这些配置。若要手动配置,可以创建一个 whisk.Config
对象并传递给 whisk.NewClient()
,如下所示:
config := &whisk.Config{
Host: "<APIHOST>",
Version: "<APIVERSION>",
Namespace: "<NAMESPACE>",
AuthToken: "<AUTH>",
}
client, err := whisk.NewClient(http.DefaultClient, config)
// 处理错误...
请确保替换 <APIHOST>
, <APIVERSION>
, <NAMESPACE>
和 <AUTH>
为你自己的值。这将覆盖默认的 wskprop
配置文件中的参数。
以上是关于 openwhisk-client-go
的简要介绍,更多详细信息请参考项目仓库的 README 文件和 Go 文档。