muonsoft/openapi-mock

OpenAPI Mock Server

镜像概述

OpenAPI Mock Server 是一个基于 OpenAPI 规范的模拟服务器，核心功能是根据指定的 API 模式自动生成随机响应数据。该镜像适用于 API 开发、测试和文档验证场景，帮助开发者在后端服务未就绪时快速搭建可用的模拟接口环境。

核心功能与特性

• OpenAPI 3.x 支持：完全兼容 OpenAPI 3.x 规范
• 多源规范加载：支持从本地文件或远程 URL 加载 OpenAPI 规范
• 格式兼容性：支持 JSON 和 YAML 两种规范文件格式
• 智能数据生成：可根据规范中的模式定义或示例生成模拟响应数据
• 内容协商：通过 HTTP 请求头 Accept 进行内容格式协商
• 部署灵活性：可作为独立应用（支持 Linux 和 Windows）或 Docker 容器运行

使用场景

• API 开发阶段：在后端服务未完成时，为前端开发提供可用的模拟接口
• 前端测试：快速验证前端对各种 API 响应的处理逻辑
• API 文档验证：验证 OpenAPI 规范定义的接口是否符合预期行为
• 集成测试：为自动化测试提供稳定的模拟数据来源

使用方法与配置说明

基本 Docker 运行命令

从本地文件加载规范

bash
docker run -p 8080:8080 -v /path/to/your/openapi-spec.yaml:/app/openapi.yaml docker.xuanyuan.run/muonsoft/openapi-mock --specification /app/openapi.yaml

从 URL 加载规范

bash
docker run -p 8080:8080 docker.xuanyuan.run/muonsoft/openapi-mock --specification https://example.com/openapi-spec.json

访问模拟服务

启动容器后，模拟服务器默认在 8080 端口运行。可通过访问 http://localhost:8080 查看 API 接口列表，或直接访问规范中定义的接口路径获取模拟响应。

内容协商示例

通过 Accept 头指定响应格式：

bash
curl -H "Accept: application/json" http://localhost:8080/api/users
curl -H "Accept: application/xml" http://localhost:8080/api/users

更多信息

项目详细文档和源码请访问：https://github.com/muonsoft/openapi-mock