nutgaard/rest-api-mock

Rest Api Mock 镜像文档

概述

一个用于创建静态模拟服务的简单Docker镜像。可通过向镜像添加文件或挂载目录来快速搭建静态API模拟服务，适用于开发和测试阶段需要模拟API响应的场景。

核心功能和特性

• 支持从静态文件提供API模拟响应
• 支持多种文件扩展名与Content-Type头的映射
• 支持索引文件机制，访问文件夹时自动使用指定顺序的索引文件
• 灵活的使用方式：可通过挂载目录或构建自定义镜像集成数据

使用场景

• 前端开发时模拟后端API响应
• 测试环境中替代真实API服务
• 快速搭建演示用静态API服务

使用方法

Docker直接运行

假设本地存在如下目录结构：

  ./
    /data
      /api
        /files
          2bc3994a98b.json
          index.json
      /bin
        /files
          2bc3994a98b.png

运行以下命令启动服务，将本地data目录挂载到容器中：

bash
docker run \
  -p 8080:8080 \
  -v $(pwd)/data:/usr/share/nginx/html \
  docker.xuanyuan.run/nutgaard/rest-api-mock

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: "3.8"
services:
  mock-server:
    image: docker.xuanyuan.run/nutgaard/rest-api-mock
    ports:
      - "8090:8080"  # 映射主机8090端口到容器8080端口
    volumes:
      - "./data:/usr/share/nginx/html"  # 挂载本地data目录

启动服务：

bash
docker-compose up -d

构建自定义镜像

如需将数据内置到镜像中，可创建自定义Dockerfile：

dockerfile
FROM docker.xuanyuan.run/nutgaard/rest-api-mock
ADD data /usr/share/nginx/html  # 将本地data目录添加到镜像中

构建并运行自定义镜像：

bash
docker build -t my-api-mock .
docker run -p 8080:8080 docker.xuanyuan.run/my-api-mock

文件扩展名与内容类型

镜像预设了多种文件扩展名与Content-Type头的映射。如需更多映射，请提交issue或PR。

索引文件机制

访问文件夹时，将自动使用目录中存在的索引文件。若存在多个索引文件，按以下优先级顺序使用： index.html > index.txt > index.json > index.png > index.pdf

鸣谢

本仓库从 https://github.com/accodeing/REST-API-mock 分叉而来，旨在将镜像发布到Docker Hub以方便使用。