mock-charles-mirror v0.0.2

Mock Charles Mirror

使用 charles mirror 保存的数据生成 mock 接口，适用于开发环境 mock 数据或调整接口

安装

直接运行

npx mock-charles-mirror [options]

全局安装

npm install --global mock-charles-mirror

本地安装

npm install mock-charles-mirror

使用

mock-charles-mirror [options]

默认会启动一个 http://127.0.0.1:3007 的服务，访问可查看和管理接口

options

前端接入使用

axios 版

import axios from "axios"
import { injectAxios } from "mock-charles-mirror"
injectAxios(axios, '127.0.0.1:3007')

// 如果是默认端口可省略参数
injectAxios(axios)

// 如果使用 axios.create 的实例
let http = axios.create(...)
injectAxios(http)

fetch 版

import fetch from "whatwg-fetch"
import { injectFetch } from "mock-charles-mirror"
fetch = injectFetch(fetch, '127.0.0.1:3007')

// 如果是默认端口可省略参数
fetch = injectFetch(fetch)

1. 启动后，前端按照上面代码示例在全局接入即可
2. 接入完成，开启使用可以在 url 参数、请求 body、页面参数里追加 __mock__=1
3. 首次使用，进入 http://127.0.0.1:3007 右上角菜单打开“开启转发”功能，保存接口数据到本地，可以后续使用或编辑

如果使用全局 fetch 的方式可以直接引入 sdk，参照 前端如何接入使用 里的 “接入 sdk（fetch版）”

如果使用其他方式的，参照前端如何接入使用 中 “请求头传参方式” 实现即可

管理功能

1. 新增一个域名或使用默认的 api.example.com，具体参见如何新增一个域名
2. 增加 mock 数据，具体参见如何添加 mock 数据
3. 使用，具体参见前端如何接入使用

开发说明

命令

// 安装依赖
npm i
// 启动
npm start

本服务使用 pm2 运行，如启动失败可以通过下面命令安装 pm2（安装到全局）

npm i -g pm2

也可以直接运行入口，但是会缺失环境变量的更改

node ./src/index.js

环境

node 14+
express 4+