stripe/stripe-mock

stripe-mock Docker镜像文档

1. 镜像概述和主要用途

stripe-mock 是一个模拟 Stripe API 的 HTTP 服务器，其响应行为与真实 Stripe API 一致。该镜像主要用于替代 Stripe 官方的测试模式（testmode），帮助开发者构建更快、更稳定的 Stripe 集成测试套件。

重要说明：本镜像替代了旧有镜像 stripemock/stripe-mock，后者将不再接收更新。如需持续获取功能更新和维护，请使用本镜像。

2. 核心功能和特性

核心功能

• 模拟 Stripe API 响应：提供与真实 Stripe API 一致的 HTTP 响应格式和行为，支持各类 Stripe API 端点（如支付意向、客户、订阅等）的模拟请求处理。

特性

• 提升测试效率：本地模拟服务消除了对外部网络请求的依赖，显著加快测试执行速度。
• 降低测试脆弱性：避免因真实 Stripe 测试环境波动（如网络延迟、服务状态变化）导致的测试不稳定问题。
• 持续更新支持：作为 stripemock/stripe-mock 的替代方案，提供持续的功能迭代和维护。

3. 使用场景和适用范围

适用场景

• 开发环境中，对集成 Stripe API 的应用进行本地功能调试。
• 测试环境中，运行与 Stripe 集成的自动化测试套件（如单元测试、集成测试）。
• CI/CD 流水线中，作为测试阶段的依赖服务，确保测试流程独立于外部服务。

适用范围

• 需要与 Stripe API 交互的应用开发团队（如电商平台、支付系统等）。
• 追求测试流程高效化、稳定性的开发和测试工作流。
• 希望避免依赖 Stripe 官方测试环境的场景。

4. 详细使用方法和配置说明

4.1 拉取镜像

bash
docker pull stripe/stripe-mock

4.2 基本运行命令

默认情况下，stripe-mock 监听容器内的 12111 端口。通过以下命令启动容器并映射端口：

bash
docker run -d -p 12111:12111 --name stripe-mock-server stripe/stripe-mock

4.3 自定义配置

stripe-mock 支持通过命令行参数调整行为，常见参数如下：

示例：指定自定义端口并启用严格模式

bash
docker run -d -p 8080:8080 stripe/stripe-mock -port 8080 -strict true

4.4 挂载自定义数据文件

如需使用自定义 API 响应数据，可通过 Docker 卷挂载本地数据文件：

bash
docker run -d -p 12111:12111 \
  -v /path/to/local/data.json:/data/custom-data.json \
  stripe/stripe-mock -data /data/custom-data.json

5. Docker 部署方案示例

5.1 单容器部署（docker run）

bash
# 启动 stripe-mock 服务，映射本地 12111 端口，后台运行
docker run -d \
  --name stripe-mock \
  -p 12111:12111 \
  --restart unless-stopped \
  stripe/stripe-mock

5.2 Docker Compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3.8'
services:
  stripe-mock:
    image: stripe/stripe-mock
    container_name: stripe-mock-server
    ports:
      - "12111:12111"
    command: -strict true  # 启用严格模式
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

6. 验证服务可用性

服务启动后，可通过以下命令验证是否正常运行：

bash
curl http://localhost:12111/v1/charges

若返回类似 Stripe API 的 JSON 响应（如空列表或模拟数据），则服务部署成功。

7. 参考链接

• GitHub 仓库：https://github.com/stripe/stripe-mock