spectolabs/hoverfly

Hoverfly Docker镜像文档

镜像概述

Hoverfly是由SpectoLabs开发的开源API模拟工具，该Docker镜像提供了便捷的部署方式，可在开发和测试流程中快速搭建API模拟服务。通过记录真实API交互或定义自定义规则，Hoverfly能够模拟HTTP/HTTPS协议的API响应，帮助团队减少对外部依赖的依赖，提升开发和测试效率。

官方网站：[]
官方文档：[]

核心功能与特性

• API流量记录与模拟：支持记录真实API交互数据，并基于记录内容模拟API响应，实现"录制-回放"工作流
• 全协议支持：完整支持HTTP和HTTPS协议，可模拟加密API通信
• 轻量级设计：容器化部署，资源占用低，启动速度快，适合本地开发和CI/CD环境集成
• 灵活配置：通过管理API或配置文件自定义模拟规则，支持动态调整响应内容、延迟、状态码等
• 多模式运行：支持"模拟模式"（Simulate）和"记录模式"（Capture），满足不同测试场景需求

使用场景与适用范围

• 第三方API依赖模拟：在开发阶段模拟未完成或外部付费API，避免开发阻塞
• 集成测试环境：为自动化测试提供稳定的API响应，消除外部依赖波动影响
• 微服务并行开发：模拟上下游微服务API，支持团队独立开发单个服务
• 故障注入测试：模拟API超时、错误状态码等异常情况，验证系统容错能力
• 前端开发联调：为前端提供稳定的后端API模拟服务，无需等待后端接口就绪

使用方法与配置说明

基本部署（Docker Run）

使用以下命令快速启动Hoverfly容器：

bash
docker run -d -p 8888:8888 -p 8500:8500 spectolabs/hoverfly:latest

参数说明：

• -d：后台运行容器
• -p 8888:8888：映射Hoverfly代理端口（用于拦截/转发API流量）
• -p 8500:8500：映射管理API端口（用于配置Hoverfly模式、导入/导出模拟数据等）
• spectolabs/hoverfly:latest：使用最新版本镜像

Docker Compose配置

如需集成到现有服务架构，可使用docker-compose.yml：

yaml
version: '3'
services:
  hoverfly:
    image: spectolabs/hoverfly:latest
    ports:
      - "8888:8888"  # 代理端口
      - "8500:8500"  # 管理API端口
    volumes:
      - ./hoverfly-data:/hoverfly  # 可选：挂载本地目录持久化模拟数据
    restart: always  # 容器退出时自动重启

基本操作示例

1. 切换至记录模式（捕获API流量）： 通过管理API发送请求：

   bash
   curl -X POST http://localhost:8500/api/v2/hoverfly/mode -H "Content-Type: application/json" -d '{"mode":"capture"}'
   

2. 切换至模拟模式（使用记录数据响应）：

   bash
   curl -X POST http://localhost:8500/api/v2/hoverfly/mode -H "Content-Type: application/json" -d '{"mode":"simulate"}'
   

3. 导出模拟数据（保存为JSON文件）：

   bash
   curl http://localhost:8500/api/v2/simulation > simulation.json
   

4. 导入模拟数据（从JSON文件加载）：

   bash
   curl -X POST http://localhost:8500/api/v2/simulation -H "Content-Type: application/json" --data-binary @simulation.json
   

进阶配置

• 持久化模拟数据：通过-v参数挂载本地目录至容器/hoverfly路径，保存模拟规则和记录数据
• 自定义启动参数：可通过Docker命令传递Hoverfly启动参数，例如指定默认模式：

  bash
  docker run -d -p 8888:8888 -p 8500:8500 spectolabs/hoverfly:latest -webserver -mode simulate
  

• HTTPS配置：如需模拟HTTPS服务，可通过管理API上传SSL证书，或使用Hoverfly内置CA生成证书

参考资源

• 完整官方文档：[***]
• 管理API文档：[***]
• GitHub代码库：https://github.com/SpectoLabs/hoverfly