Microcks Docker Desktop 扩展

镜像概述和主要用途

Microcks Docker Desktop 扩展是一款专为 Docker Desktop 设计的插件，旨在简化 Microcks 的部署与管理流程。Microcks 是一款开源的 API 模拟与测试工具，支持 REST、SOAP、gRPC、GraphQL 等多种 API 类型。该扩展通过与 Docker Desktop 深度集成，使开发者和测试人员能够直接在 Docker Desktop 界面中一键部署、配置和管理 Microcks 实例，快速搭建本地 API 模拟与测试环境，从而加速 API 开发、测试与集成流程。

核心功能和特性

核心功能

• Docker Desktop 原生集成：直接在 Docker Desktop 界面中提供图形化操作入口，支持启动、停止、配置 Microcks 实例。
• 一键部署：无需手动编写 Docker 配置文件，通过扩展界面即可完成 Microcks 及依赖组件（如数据库）的自动化部署。
• 集成化管理：支持在 Docker Desktop 中查看 Microcks 运行状态、资源占用、日志输出，简化运维操作。
• Microcks 核心能力：完整支持 Microcks 的 API 模拟（Mocking）、API 测试（Testing）、契约测试（Contract Testing）等核心功能。

特性

• 轻量化部署：基于容器化架构，资源占用可控，适合本地开发环境。
• 数据持久化：支持配置数据持久化路径，确保模拟定义、测试结果等数据不丢失。
• 版本兼容性：适配主流 Docker Desktop 版本（建议 Docker Desktop 4.8+），并同步支持 Microcks 最新稳定版功能。
• 零额外依赖：扩展内置 Microcks 运行所需的基础组件（如嵌入式数据库），开箱即用。

使用场景和适用范围

典型使用场景

• 开发阶段 API 依赖模拟：前端或客户端开发时，后端 API 服务未就绪，通过 Microcks 模拟 API 响应，避免开发阻塞。
• API 测试自动化：集成到 CI/CD 流程中，对 API 端点进行自动化测试，验证接口兼容性与功能正确性。
• 契约测试实施：与 Spring Cloud Contract、Pact 等契约工具集成，实现 API 契约的自动验证与版本管理。
• 微服务依赖管理：在微服务架构中，模拟下游服务接口，解决服务间调用依赖问题，简化本地联调。

适用范围

• 用户群体：开发者、测试工程师、DevOps 团队。
• 技术场景：API 优先开发（API-First）、微服务架构、前后端分离开发、持续集成/持续部署（CI/CD）流程。

详细的使用方法和配置说明

前提条件

• Docker Desktop 4.8.0 及以上版本（需启用 Extensions 功能）。
• 网络连接（用于下载扩展及 Microcks 基础镜像）。

1. 安装扩展

1. 打开 Docker Desktop，进入左侧导航栏的 Extensions 页面。
2. 在 Extensions Marketplace 中搜索 Microcks，点击 Install。
3. 等待扩展下载并安装完成（首次安装需拉取 Microcks 及依赖镜像，耗时取决于网络速度）。

2. 启动与访问 Microcks

1. 安装完成后，在 Docker Desktop 的 Extensions 页面点击 Microcks 图标启动扩展。
2. 扩展启动后，界面将显示 Microcks 服务状态（如 "Running"）及访问链接（默认：http://localhost:8080）。
3. 点击访问链接或手动在浏览器中输入地址，进入 Microcks Web 控制台（默认用户名/密码：admin/admin）。

3. 核心配置说明

扩展支持通过 Docker Desktop 界面或配置文件自定义参数，主要配置项如下：

4. 自定义配置（高级）

若需自定义配置，可通过扩展界面的 Settings 选项卡修改，或在扩展安装目录下编辑 docker-compose.yml（仅建议高级用户操作）。示例配置片段：

yaml
# 扩展内部默认 docker-compose 结构（供参考）
version: '3.8'
services:
  microcks:
    image: microcks/microcks:latest
    ports:
      - "8080:8080"
    volumes:
      - ${PERSISTENCE_PATH}:/app/data
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - LOG_LEVEL=INFO
      - POSTGRES_URL=jdbc:postgresql://postgres:5432/microcks  # 若使用外部 PostgreSQL
    depends_on:
      - postgres  # 可选，外部数据库时需注释

  postgres:  # 内置 PostgreSQL（默认禁用，需手动启用）
    image: postgres:14-alpine
    volumes:
      - postgres-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=microcks
      - POSTGRES_USER=microcks
      - POSTGRES_PASSWORD=microcks

volumes:
  postgres-data:

5. 使用示例：创建 API 模拟服务

1. 登录 Microcks Web 控制台（http://localhost:8080）。
2. 点击左侧 Importers，选择 OpenAPI/Swagger 导入方式。
3. 上传或输入 OpenAPI 规范文件 URL（如 [***]）。
4. 点击 Import，等待导入完成后，在 Services 页面可见创建的 Petstore API 服务。
5. 点击服务名称，查看模拟端点（如 http://localhost:8080/rest/Petstore/1.0.0），通过 curl 或工具发送请求验证模拟效果：

   bash
   curl http://localhost:8080/rest/Petstore/1.0.0/pets/1
   

6. 停止与卸载

• 停止服务：在 Docker Desktop 扩展界面点击 Stop 按钮。
• 卸载扩展：在 Docker Desktop Extensions 页面，右键点击 Microcks 扩展，选择 Uninstall。
• 清理数据：卸载后若需删除持久化数据，手动删除 ~/.docker/microcks/data 目录。

配置参数与环境变量

扩展支持通过环境变量自定义 Microcks 运行参数，主要变量如下表：

部署方案示例（扩展内部配置参考）

以下为扩展内部默认的容器编排逻辑（简化版 docker-compose.yml），供高级用户自定义参考：

yaml
version: '3.8'
services:
  microcks:
    image: microcks/microcks:latest
    container_name: microcks
    restart: unless-stopped
    ports:
      - "${MICROCKS_PORT:-8080}:8080"
    volumes:
      - "${PERSISTENCE_PATH:-~/.docker/microcks/data}:/app/data"
    environment:
      - SPRING_PROFILES_ACTIVE=${DATABASE_TYPE:-h2}
      - LOG_LEVEL=${LOG_LEVEL:-INFO}
      - SPRING_DATASOURCE_URL=${POSTGRES_URL}
      - SPRING_DATASOURCE_USERNAME=${POSTGRES_USER}
      - SPRING_DATASOURCE_PASSWORD=${POSTGRES_PASSWORD}
    networks:
      - microcks-network

networks:
  microcks-network:
    driver: bridge

注：通过 Docker Desktop 扩展安装时，上述配置由扩展自动生成，无需手动编写。自定义场景下，可通过修改环境变量或挂载配置文件调整参数。