palo/swagger-api-mock

swagger-api-mock 镜像说明

镜像概述

本镜像基于Swagger规范构建API模拟服务器，通过解析swagger.yaml文件快速生成模拟接口服务，支持实时更新配置和自动处理跨域请求，适用于前端开发、API测试等场景。

核心功能

• 解析swagger.yaml文件生成模拟接口
• 实时更新：修改配置文件后刷新浏览器即可生效
• 自动处理CORS跨域请求：适配前端跨域访问需求

使用场景

1. 前端开发阶段，后端接口未就绪时模拟数据交互
2. API测试场景中，快速构建模拟环境验证接口逻辑
3. 原型演示或Demo开发，提供临时接口服务

配置说明

快速体验示例

直接运行镜像查看默认模拟接口：

bash
docker run -i \
    -p 8000:8000 \
    -t docker.xuanyuan.run/palo/swagger-api-mock

（注：-i参数确保ctrl-c可正常终止进程）

挂载自定义swagger.yaml

将包含swagger.yaml的本地文件夹挂载到/data目录：

bash
docker run -i \
    -p 8000:8000 \
    -v /本地路径/到/配置文件夹:/data \
    -t docker.xuanyuan.run/palo/swagger-api-mock

要求文件夹内文件名为swagger.yaml。

指定自定义名称的YAML文件

若配置文件名称非swagger.yaml，可直接挂载文件到目标路径：

bash
docker run -i \
    -p 8000:8000 \
    -v /本地路径/到/自定义文件.yaml:/data/swagger.yaml \
    -t docker.xuanyuan.run/palo/swagger-api-mock

CORS支持细节

镜像自动设置跨域相关HTTP头：

• Access-Control-Allow-Origin：请求含Origin头则返回该值，否则返回*
• Access-Control-Allow-Credentials：Allow-Origin为*时返回false，否则返回true
• Access-Control-Allow-Methods：始终返回所有HTTP方法
• Access-Control-Allow-Headers：请求含Access-Control-Request-Headers则返回该值，否则不设置
• OPTIONS预请求始终返回200状态码（即使未在YAML中声明）

相关链接

• https://www.npmjs.com/package/swagger-mock-api
• https://hub.docker.com/r/palo/swagger-api-mock
• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
• https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS