akamai/httpie

HTTPie with Akamai EdgeGrid Authentication 镜像文档

镜像概述和主要用途

本镜像是 HTTPie 工具与 Akamai EdgeGrid Authentication 插件的集成版本，旨在简化向 Akamai API 发送 HTTP 请求时的认证流程。HTTPie 是一款简洁高效的命令行 HTTP 客户端，而 Akamai EdgeGrid 是 Akamai API 的标准认证机制。通过本镜像，用户无需手动配置依赖环境，可直接使用预集成的工具链向 Akamai API 发送经过 EdgeGrid 认证的 HTTP 请求，适用于开发、测试及自动化场景。

核心功能和特性

基础功能

• HTTPie 原生功能：支持 JSON 格式请求、表单提交、自定义请求头、响应格式化输出等 HTTPie 核心能力。
• EdgeGrid 认证集成：内置 httpie-edgegrid 插件，自动处理 Akamai API 认证所需的签名生成逻辑，无需手动实现认证算法。

特性

• 零依赖部署：Docker 容器化封装，无需在主机环境安装 Python、HTTPie 或插件依赖。
• 跨平台兼容：支持所有 Docker 兼容的操作系统（Linux、macOS、Windows）。
• 配置灵活：通过环境变量注入认证凭证，适配不同环境（开发、测试、生产）的凭证管理需求。

使用场景和适用范围

适用场景

• Akamai API 开发与调试：快速验证 API 端点功能及响应格式。
• 自动化脚本集成：在 Shell/Python 脚本中调用 Akamai 服务（如配置更新、性能监控）。
• CI/CD 流程嵌入：在持续集成/部署管道中自动化执行 Akamai 相关操作（如推送配置、触发缓存刷新）。
• 批量操作处理：通过脚本批量调用 Akamai API 完成重复任务（如多域名配置同步）。

适用用户

• Akamai 服务开发者/管理员
• 需要与 Akamai API 交互的 DevOps 工程师
• 自动化脚本编写者

使用方法和配置说明

前提条件

• 已安装 Docker 引擎（20.10+ 版本推荐）。
• 已获取 Akamai EdgeGrid 认证凭证（包括 Host、Client Token、Client Secret、Access Token），需从 Akamai Control Center 的 "API Access" 部分生成。

环境变量配置

EdgeGrid 认证需通过以下环境变量注入凭证，所有变量为必填项：

Docker 快速启动

基础用法（docker run）

通过以下命令运行容器，直接发送经过 EdgeGrid 认证的 HTTP 请求至 Akamai API：

bash
docker run --rm \
  -e AKAMAI_EDGEGRID_HOST="akab-xxxx.luna.akamaiapis.net" \
  -e AKAMAI_EDGEGRID_CLIENT_TOKEN="akab-xxxx" \
  -e AKAMAI_EDGEGRID_CLIENT_SECRET="xxxx" \
  -e AKAMAI_EDGEGRID_ACCESS_TOKEN="akab-xxxx" \
  httpie-edgegrid \
  http GET /api/v1/endpoint "Accept:application/json"

说明：命令末尾的 http GET /api/v1/endpoint "Accept:application/json" 为 HTTPie 命令参数，格式与原生 HTTPie 一致（http <方法> <路径> [请求头/参数]）。

持久化配置（docker-compose）

通过 docker-compose.yml 管理容器，适合频繁使用场景：

yaml
version: "3"
services:
  akamai-httpie:
    image: httpie-edgegrid
    environment:
      - AKAMAI_EDGEGRID_HOST=akab-xxxx.luna.akamaiapis.net
      - AKAMAI_EDGEGRID_CLIENT_TOKEN=akab-xxxx
      - AKAMAI_EDGEGRID_CLIENT_SECRET=xxxx
      - AKAMAI_EDGEGRID_ACCESS_TOKEN=akab-xxxx
    # 可选：挂载本地目录以共享请求文件（如 JSON  payload）
    volumes:
      - ./requests:/requests

启动服务：

bash
docker-compose run --rm akamai-httpie http GET /api/v1/endpoint

示例操作

1. 获取 Akamai 配置版本信息

向 Akamai Property Manager API 发送 GET 请求，获取指定属性的版本列表：

bash
docker run --rm \
  -e AKAMAI_EDGEGRID_HOST="akab-xxxx.luna.akamaiapis.net" \
  -e AKAMAI_EDGEGRID_CLIENT_TOKEN="akab-xxxx" \
  -e AKAMAI_EDGEGRID_CLIENT_SECRET="xxxx" \
  -e AKAMAI_EDGEGRID_ACCESS_TOKEN="akab-xxxx" \
  httpie-edgegrid \
  http GET /papi/v1/properties/prp_xxxx/versions "Accept:application/json"

2. 提交 JSON 格式 POST 请求

向 Akamai API 发送带 JSON payload 的 POST 请求（假设本地 payload.json 文件需挂载至容器）：

bash
docker run --rm \
  -v $(pwd)/payload.json:/payload.json \
  -e AKAMAI_EDGEGRID_HOST="akab-xxxx.luna.akamaiapis.net" \
  -e AKAMAI_EDGEGRID_CLIENT_TOKEN="akab-xxxx" \
  -e AKAMAI_EDGEGRID_CLIENT_SECRET="xxxx" \
  -e AKAMAI_EDGEGRID_ACCESS_TOKEN="akab-xxxx" \
  httpie-edgegrid \
  http POST /api/v1/resource "Content-Type:application/json" @/payload.json

注意事项

• 凭证安全：AKAMAI_EDGEGRID_CLIENT_SECRET 为敏感信息，建议通过环境变量文件（如 --env-file .env）或 secrets 管理工具注入，避免明文暴露。
• API 路径：Akamai API 路径需以 / 开头（如 /api/v1/endpoint），且无需包含主机名（主机由 AKAMAI_EDGEGRID_HOST 指定）。
• HTTPie 参数：所有 HTTPie 原生参数（如 -v 显示详细请求、-o output.json 保存响应）均可直接添加至容器命令末尾。

参考链接

• HTTPie 官方文档
• Akamai EdgeGrid Authentication 规范
• https://github.com/akamai/httpie-edgegrid