OpenWhisk API Gateway 技术文档

1. 安装指南

在开始之前，请确保您的系统中已安装 Docker。以下是基于 Docker 的 OpenWhisk API Gateway 安装步骤：

docker run -p 80:80 -p <managedurl_port>:8080 -p 9000:9000 \
            -e PUBLIC_MANAGEDURL_HOST=<managedurl_host> \
            -e PUBLIC_MANAGEDURL_PORT=<managedurl_port> \
            -e REDIS_HOST=<redis_host> \
            -e REDIS_PORT=<redis_port> \
            -e REDIS_PASS=<redis_pass> \
            openwhisk/apigateway:latest

如果需要使用加密的 Redis 密码，请设置以下环境变量：

• DECRYPT_REDIS_PASS=true
• ENCRYPTION_KEY=<32字节十六进制字符串，用于加密>
• ENCRYPTION_IV=<16字节十六进制字符串，用于加密>

2. 项目使用说明

OpenWhisk API Gateway 是一个基于 Openresty 和 NGINX 的高性能 API 网关。以下是项目的基本使用说明：

• 使用环境变量配置 API 网关。
• 通过环境变量 REMOTE_CONFIG 从远程源同步配置文件。
• 使用 REMOTE_CONFIG_SYNC_INTERVAL 设置同步间隔。
• 使用 REMOTE_CONFIG_RELOAD_CMD 配置网关重载命令。

3. 项目 API 使用文档

OpenWhisk API Gateway 提供了以下管理接口：

• v2 Management Interface
• v1 Management Interface

4. 项目安装方式

本地构建 Docker 镜像

使用以下命令在本地构建 Docker 镜像：

make docker

运行 Docker 镜像

使用以下命令运行 Docker 镜像：

make docker-run PUBLIC_MANAGEDURL_HOST=<managedurl_host> PUBLIC_MANAGEDURL_PORT=<managedurl_port> \
    REDIS_HOST=<redis_host> REDIS_PORT=<redis_port> REDIS_PASS=<redis_pass>

运行测试

使用以下命令构建测试镜像并运行单元测试：

make test

请根据实际情况替换 <managedurl_host>、<managedurl_port>、<redis_host>、<redis_port> 和 <redis_pass> 等占位符。