jormaechea/open-api-mocker

Open API Mocker 镜像文档

镜像概述

Open API Mocker 是一个基于 Open API 3.0 规范的 API 模拟工具，能够根据 Open API 3.0 规范文件自动生成模拟 API 服务。该工具旨在帮助开发人员在后端 API 未就绪时，快速搭建模拟接口环境，支持前端开发、API 测试及演示等场景。

核心功能与特性

• 基于 Open API 3.0 规范：完全遵循 Open API 3.0 规范，可直接解析规范文件生成模拟接口
• 自动模拟响应：根据规范中定义的响应结构和示例，自动返回模拟数据
• 轻量级部署：通过 Docker 容器化部署，快速启动，无需复杂配置
• 支持动态更新：可通过挂载规范文件实现配置动态更新，无需重启服务

使用场景与适用范围

• 前端开发：在后端 API 尚未开发完成时，提供模拟接口支持前端联调
• API 测试：模拟不同响应场景（成功、错误、异常等），验证 API 调用逻辑
• 演示环境：快速搭建具有模拟数据的演示环境，展示 API 功能
• 文档验证：验证 Open API 3.0 规范文件的有效性和完整性

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动 Open API Mocker 容器，需挂载本地 Open API 3.0 规范文件：

bash
docker run -d \
  -p 8080:8080 \
  -v /path/to/your/openapi.yaml:/app/openapi.yaml \
  docker.xuanyuan.run/jormaechea/open-api-mocker

参数说明：

• -p 8080:8080：将容器内 8080 端口映射到宿主机 8080 端口，可根据需要修改
• -v /path/to/your/openapi.yaml:/app/openapi.yaml：挂载本地 Open API 3.0 规范文件到容器内指定路径

Docker Compose 配置

创建 docker-compose.yml 文件，内容如下：

yaml
version: '3'
services:
  open-api-mocker:
    image: docker.xuanyuan.run/jormaechea/open-api-mocker
    ports:
      - "8080:8080"
    volumes:
      - ./openapi.yaml:/app/openapi.yaml
    restart: always

启动服务：

bash
docker-compose up -d

访问模拟 API

服务启动后，可通过 http://localhost:8080 访问模拟 API。具体接口路径、请求方法及响应格式需根据挂载的 Open API 3.0 规范文件定义。

配置参数

目前官方未明确提供额外环境变量配置，主要通过挂载 Open API 3.0 规范文件进行功能定义。更多配置细节可参考 https://github.com/jormaechea/open-api-mocker。