update doc

This commit is contained in:
dongzp 2026-04-22 15:46:24 +08:00
parent 6244592649
commit cab53e7947

View File

@ -1,10 +1,10 @@
## API Proxy Mock ## API Proxy Mock
基于 Node.js 的轻量级 **HTTP 代理 + 本地 Mock**:在 `config.json` 里配置要拦截的路径和本地文件,其余请求通过 **HTTPS** 转发到真实后端。 基于 Node.js 的轻量级 **HTTP 代理 + 本地 Mock**:在 `config.json` 里配置要拦截的路径和本地文件,其余请求按配置HTTP/HTTPS转发到真实后端。
### 功能说明 ### 功能说明
- **代理转发**:未命中 Mock 的请求会转发到 `config.targetHost`HTTPS`targetPort` 可配,默认 443)。 - **代理转发**:未命中 Mock 的请求会转发到 `config.targetHost``targetHttps` 决定 HTTP/HTTPS`targetPort` 可配)。
- **本地 Mock**:命中路由时直接读取 `mock` 目录下的文件作为响应体。 - **本地 Mock**:命中路由时直接读取 `mock` 目录下的文件作为响应体。
- **Mock 总开关**`mockEnabled``false` 时**不拦截**任何 Mock 路由,全部走代理。 - **Mock 总开关**`mockEnabled``false` 时**不拦截**任何 Mock 路由,全部走代理。
- **热更新**`reloadOnChange``true` 时监听 `config.json` 变更并自动重载;也可通过管理接口手动重载。 - **热更新**`reloadOnChange``true` 时监听 `config.json` 变更并自动重载;也可通过管理接口手动重载。
@ -61,7 +61,8 @@ npm run typecheck
"defaultContentType": "application/json", "defaultContentType": "application/json",
"proxyPort": 8877, "proxyPort": 8877,
"targetHost": "example.com", "targetHost": "example.com",
"targetPort": 443 "targetPort": 443,
"targetHttps": true
} }
} }
``` ```
@ -83,8 +84,9 @@ npm run typecheck
| `reloadOnChange` | 是否监视 `config.json` 文件变化并自动重新加载。 | | `reloadOnChange` | 是否监视 `config.json` 文件变化并自动重新加载。 |
| `defaultContentType` | Mock 成功时的 `Content-Type`,常用 `"application/json"`。 | | `defaultContentType` | Mock 成功时的 `Content-Type`,常用 `"application/json"`。 |
| `proxyPort` | 本机 HTTP 代理监听端口。 | | `proxyPort` | 本机 HTTP 代理监听端口。 |
| `targetHost` | 上游 HTTPS 主机名(不含协议与路径)。 | | `targetHost` | 上游主机名(不含协议与路径)。 |
| `targetPort` | 可选。上游 HTTPS 端口,**缺省为 443**。非 443 时请在配置中显式写出。 | | `targetPort` | 可选。上游端口;当 `targetHttps=true` 缺省为 `443`,当 `targetHttps=false` 缺省为 `80`。 |
| `targetHttps` | 可选。是否使用 HTTPS 连接上游;`true` 为 HTTPS`false` 为 HTTP。缺省为 `true`。 |
### 管理接口 ### 管理接口