Quickmock API 文档

通过 JSON API 创建一个端点或完整的多路由模拟工作区。下面的每个示例都可以复制粘贴,并使用与 Web 构建器相同的约定。

下载 OpenAPI 3.1 规范

创建一个模拟

POST /api/mocks 返回公共 URL 和一次性 admin_token。保留该令牌:更新、删除和私有日志将其作为 Bearer 令牌需要。

curl -X POST https://quickmock.dev/api/mocks \
  -H 'Content-Type: application/json' \
  -d '{"method":"GET","response_status":200,"content_type":"application/json","response_body":"{\"ok\":true}","ttl_seconds":604800}'

命名响应变体

变体使边缘情况具有确定性。使用 X-Quickmock-Variant 或 __quickmock_variant 选择一个;未知的名称将回退到正常匹配。

"response_variants": [
  {"name":"not-found","status":404,"body":"{\"error\":\"not found\"}"}
]

curl -H 'X-Quickmock-Variant: not-found' https://quickmock.dev/m/<slug>
curl 'https://quickmock.dev/m/<slug>?__quickmock_variant=not-found'

条件响应规则

规则按顺序运行,第一个完全匹配的获胜。来源:方法、路径、查询、标头和 JSON body 路径。运算符:equals(等于)、not_equals(不等于)、contains(包含)和 exists(存在)。

"response_rules": [{
  "name":"missing user",
  "variant":"not-found",
  "conditions":[{"source":"query","key":"id","operator":"equals","value":"missing"}]
}]

多路由工作区

一个 slug 可以暴露多达 50 个方法 + 路径路由。OpenAPI 风格的路径占位符(如 {id})匹配一个段。

"routes": [
  {"method":"GET","path":"/users/{id}","response_status":200,"content_type":"application/json","response_body":"{\"id\":1}"},
  {"method":"POST","path":"/users","response_status":201,"content_type":"application/json","response_body":"{\"created\":true}"}
]

检查器隐私

请求日志默认是私有的。选择是否保留请求体和发送者 IP;常见的凭据标头总是会被脱敏。

"logs_public": false,
"capture_body": true,
"capture_ip": false