aktosecurity/akto-api-testing

镜像概述

本Docker镜像专为API测试场景设计，集成Newman（Postman命令行工具）、Apache JMeter等主流API测试工具，提供开箱即用的API测试环境。无需在本地手动配置测试工具及依赖，通过容器化部署即可快速执行API功能验证、性能测试和自动化测试任务，有效降低测试环境搭建成本，确保测试执行的一致性。

核心功能与特性

工具集成

• 多工具支持：内置Newman（Postman集合执行）、Apache JMeter（性能测试），满足功能测试与性能测试需求
• 轻量级基础：基于Alpine Linux构建，镜像体积小，启动速度快
• 依赖预配置：已预装Node.js（Newman依赖）、Java（JMeter依赖）及测试辅助工具（如curl、jq）

测试能力

• 功能测试：支持Postman集合（JSON格式）、JMeter脚本（JMX文件）执行，验证API接口正确性
• 性能测试：通过JMeter实现接口并发访问、响应时间统计、吞吐量分析
• 报告生成：内置Newman HTML报告、JMeter CSV/HTML报告插件，支持测试结果可视化

工程化支持

• CI/CD集成：兼容Jenkins、GitLab CI、GitHub Actions等持续集成平台，可作为流水线步骤自动执行测试
• 配置灵活：支持通过环境变量、卷挂载自定义测试脚本、报告路径及工具参数
• 跨平台兼容：支持Linux/Windows/macOS系统，确保不同环境下测试行为一致

使用场景

• 开发阶段快速验证：开发人员本地启动容器，即时测试API接口功能，无需配置复杂测试环境
• 持续集成自动化测试：在CI流程中集成镜像，代码提交后自动执行API测试用例，阻断不合格代码合并
• 团队共享测试环境：统一团队测试工具版本与配置，避免因本地环境差异导致的测试结果不一致
• API性能评估：通过JMeter执行压力测试，评估接口在高并发场景下的稳定性与响应性能

使用方法

基础使用（docker run）

1. 执行Postman集合测试（Newman）

bash
# 挂载本地测试脚本目录和报告输出目录
docker run -it --rm \
  -v $(pwd)/postman_collections:/tests \  # 本地Postman集合目录挂载到容器/tests
  -v $(pwd)/reports:/reports \            # 报告输出目录挂载到容器/reports
  api-testing-image \                     # 镜像名称
  newman run /tests/api_collection.json -r html --reporter-html-export /reports/newman_report.html

2. 执行JMeter性能测试

bash
docker run -it --rm \
  -v $(pwd)/jmeter_scripts:/tests \       # 本地JMeter脚本目录挂载到容器/tests
  -v $(pwd)/jmeter_reports:/reports \     # JMeter报告输出目录
  api-testing-image \
  jmeter -n -t /tests/performance_test.jmx -l /reports/result.jtl -e -o /reports/html_report

Docker Compose配置示例

yaml
version: '3.8'
services:
  api-test:
    image: api-testing-image
    volumes:
      - ./postman_collections:/tests        # 测试脚本目录
      - ./reports:/reports                  # 报告输出目录
    environment:
      - TEST_TOOL=newman                    # 指定测试工具（newman/jmeter）
      - REPORT_FORMAT=html                  # 报告格式（仅newman生效）
    command: newman run /tests/api_collection.json -r html --reporter-html-export /reports/report.html

配置参数说明

环境变量

卷挂载说明

注意事项

• 执行JMeter性能测试时，建议根据宿主机CPU/内存资源调整JMETER_THREADS参数，避免资源耗尽
• Postman集合文件需确保格式正确（可通过Postman客户端导出）
• 报告目录挂载时需确保本地目录有写入权限，避免报告生成失败
• 如需扩展工具（如k6、REST-assured），可基于本镜像通过Dockerfile自定义构建