ngapimock/standalone

ng-apimock独立Docker镜像文档

镜像概述和主要用途

ng-apimock独立Docker镜像是基于ng-apimock核心构建的轻量级API模拟服务器，旨在快速搭建本地或开发环境的API模拟服务。通过挂载自定义模拟数据和扩展脚本，可灵活模拟后端接口响应，支持请求代理等高级功能，并提供直观的开发界面便于接口管理和调试。

核心功能和特性

• 自定义模拟数据：支持挂载本地目录提供模拟接口数据
• 扩展能力：通过extension.js实现请求代理等自定义业务逻辑
• 开发界面：内置dev-interface可视化管理工具
• 固定端口：默认使用3000端口，配置简单

使用场景和适用范围

• 前端开发：后端API未就绪时，提供模拟接口支持前端开发调试
• API测试：快速构建测试环境，模拟不同响应状态（成功、错误、超时等）
• 前后端分离项目：作为临时API服务，加速开发流程

使用方法和配置说明

手动启动容器

通过以下命令手动启动ng-apimock容器：

bash
$ docker run --name my-mock-server -d -p 3000:3000 -v ./mocks:/opt/ngapimock/mocks -v ./extension.js:/opt/ngapimock/extension.js ngapimock/standalone:latest

使用docker-compose部署

创建docker-compose.yaml配置文件：

yaml
version: '3.3'

services:
  ngapimock-standalone:
    image: ngapimock/standalone:latest
    restart: always
    ports:
      - '3000:3000'
    expose:
      - '3000'
    volumes:
      - ./mocks:/opt/ngapimock/mocks  # 挂载模拟数据目录
      - ./extension.js:/opt/ngapimock/extension.js  # 挂载扩展脚本（可选）

启动服务：docker-compose up -d

端口说明

默认服务端口：3000

模拟数据配置（Mocks）

模拟数据需存储在本地目录，并通过卷挂载到容器内路径/opt/ngapimock/mocks。容器启动后会自动读取该目录下的模拟数据文件。

扩展脚本配置（extension.js）

extension.js是可选的扩展文件，用于实现自定义功能（如请求代理）。需将本地文件挂载到容器内路径/opt/ngapimock/extension.js。

示例extension.js代码（请求代理功能）：

js
module.exports = {
    extend: extend
}
function extend(app) {
    console.log("扩展服务器功能");

    const { createProxyMiddleware } = require('http-proxy-middleware');

    // 配置请求代理示例
    app.use('/some/path', createProxyMiddleware({ 
        target: 'https://some.api', 
        changeOrigin: true, 
        timeout: 5000 
    }));
}

开发界面访问（Dev-interface）

开发界面用于管理和调试模拟接口，访问地址：

http://localhost:3000/dev-interface

官方文档

ng-apimock核心功能详细文档：https://github.com/ng-apimock/core