Apache OpenWhisk Python 客户端技术文档

1. 安装指南

环境要求

• Python 3.6 或更高版本
• requests 库（用于发送 HTTP 请求）

安装步骤

1. 安装 Python：确保你的系统上已经安装了 Python 3.6 或更高版本。你可以通过以下命令检查 Python 版本：

   python3 --version
   

2. 安装 requests 库：使用 pip 安装 requests 库，该库用于与 OpenWhisk 的 REST API 进行交互。

   pip install requests
   

2. 项目的使用说明

使用示例

以下是一个使用 Python 调用 OpenWhisk 中 echo 动作的示例代码：

import subprocess
import requests

APIHOST = 'https://openwhisk.ng.bluemix.net'
AUTH_KEY = subprocess.check_output("wsk property get --auth", shell=True).split()[2]
NAMESPACE = 'whisk.system'
ACTION = 'utils/echo'
PARAMS = {'myKey':'myValue'}
BLOCKING = 'true'
RESULT = 'true'

url = APIHOST + '/api/v1/namespaces/' + NAMESPACE + '/actions/' + ACTION
user_pass = AUTH_KEY.split(':')
response = requests.post(url, json=PARAMS, params={'blocking': BLOCKING, 'result': RESULT}, auth=(user_pass[0], user_pass[1]))
print(response.text)

代码说明

• APIHOST：OpenWhisk 的 API 主机地址。
• AUTH_KEY：通过 wsk 命令获取的认证密钥。
• NAMESPACE：命名空间，通常为 whisk.system。
• ACTION：要调用的动作名称，例如 utils/echo。
• PARAMS：传递给动作的参数。
• BLOCKING 和 RESULT：控制请求的阻塞和结果返回方式。

3. 项目 API 使用文档

API 调用方式

OpenWhisk 提供了 REST API，可以通过 Python 的 requests 库进行调用。以下是一些常见的 API 调用方式：

调用动作

response = requests.post(url, json=PARAMS, params={'blocking': BLOCKING, 'result': RESULT}, auth=(user_pass[0], user_pass[1]))

获取动作列表

url = APIHOST + '/api/v1/namespaces/' + NAMESPACE + '/actions'
response = requests.get(url, auth=(user_pass[0], user_pass[1]))
print(response.text)

创建动作

url = APIHOST + '/api/v1/namespaces/' + NAMESPACE + '/actions/myAction'
response = requests.put(url, json=ACTION_CODE, auth=(user_pass[0], user_pass[1]))
print(response.text)

API 参数说明

• url：API 的完整 URL。
• json：传递给 API 的 JSON 数据。
• params：URL 参数。
• auth：认证信息，通常为 user:password 格式。

4. 项目安装方式

通过 pip 安装

目前没有官方的 Python 客户端库，但你可以通过 pip 安装 requests 库来使用 OpenWhisk 的 REST API。

pip install requests

手动安装

如果你需要手动安装 requests 库，可以从其官方 GitHub 仓库下载源码并进行安装：

git clone https://github.com/psf/requests.git
cd requests
python setup.py install

通过以上步骤，你可以成功安装并使用 Python 与 OpenWhisk 进行交互。