访问地址与项目
访问地址与私有路径
| 可见性 | 地址形态 | 说明 |
|---|---|---|
| 公开 | /m/{你的路径} | 出现在首页「用户公开的 API」列表,任何人可调用 |
| 私有(已登录) | /m/u/{你的命名空间}/{路径} | 不出现在公开列表,只有你知道地址 |
私有 ≠ 需要认证。私有只是"不上公开列表 + 挂在你个人的命名空间下",调用时照样直接请求即可,不需要带 token。这样前端代码里用起来和公开接口一样,别人又猜不到地址。
登录后创建的接口默认私有并永久保存在你账号下;未登录创建的接口强制公开,且1 天后自动过期。
命名空间在首次登录时自动分配,不同用户之间互不影响:哪怕两个人都建了 user/info,地址也不会冲突。
编号地址:编号是"命名空间的替身",不是前缀
每条规则还有一个编号(如 kxzkuldn2n),它稳定不变,改名字、换项目、可见性怎么切都不影响。公开列表上印的就是编号地址,这样既不暴露你的命名空间,接口转私有后链接也不会因为改名而失效。
| 写法 | 能不能用 | 说明 |
|---|---|---|
/m/{编号} | ✅ | 路径里没有变量时的标准写法 |
/m/{编号}/{项目前缀}/{路径} | ✅ | 路径里带 {id} 这类变量时要用这种,编号放在命名空间的位置上 |
/m/{编号}/5 | ❌ 404 | 编号不是前缀,别在它后面直接拼 id |
/m/u/{命名空间}/{项目前缀}/{路径} | ✅ | 空间地址,私有接口只有这一种 |
为什么 /m/{编号} 访问带变量的规则会不对劲:匹配要求路径段数完全相等,光秃秃的编号只有一段,所以 products/{id} 里的 {id} 取不到,{{request.path.id}} 会原样吐出,绑了数据集的规则返回的是整张表而不是单条。正确写法是 /m/{编号}/products/5。
拼错了不用猜:404 响应里会直接给出正确写法。
{ "code": 404, "message": "没有匹配到任何 mock 规则",
"hint": "编号 kxzkuldn2n 对应的路径是 products/{id};编号不是前缀,要写成 /m/kxzkuldn2n/products/{id}" }
登录成功后会自动跳到我的控制台,那里有统计面板(API 数、调用量、状态码分布、调用量 Top)、我的 API 列表,以及「调用日志」页。
列表里那几个按钮
| 按钮 | 作用 |
|---|---|
| 复制地址 | 把完整调用地址复制到剪贴板 |
| 代码 | 弹出调用示例,按语言分页签:cURL / JavaScript / Python / Java / Go / PHP,每段都能一键复制;代码带语法着色和行号(跟控制台里的编辑框同一套)。弹窗里还有一排示例请求(见下),点一下语言代码里的地址、参数、请求头会跟着换 |
| 统计 | 弹出这条 API 的多维调用统计:累计命中、近 24 小时 / 近 7 天、失败率、平均与 P95 耗时、状态码分布、请求方法分布、近 14 天趋势、24 小时分布、来源 IP / 客户端 / 请求地址 Top |
| 编辑 | 打开表单修改,地址不变 |
| 停用 / 启用 | 停用后调用直接返回 404 并从公开列表移除(地址和内容都保留,随时可再启用)。停用和启用都会先弹确认框,跟删除一样,避免误点 |
| 删除 | 删除后地址立即失效,同样需要确认 |
「代码」弹窗里的示例请求
规则地址往往只是个模板:/pets/{petId} 要换成真实 id、条件要带参数才命中、数据集还有一批查询参数。「代码」弹窗会按这条规则的内容推导出一组复制过去就能跑的例子,点一下就切换,下面的语言代码(地址、查询参数、请求头、请求体)同步变。
| 示例 | 什么时候出现 | 长什么样 |
|---|---|---|
| 规则地址 | 始终 | /m/v1/pets/{petId}(原始地址,带路径变量占位符) |
| 替换路径变量 | 路径里有 {xxx} | /m/v1/pets/1001,把变量换成真实的业务值(默认选中这条) |
| 命中条件 | 规则配了匹配条件 | 把条件值拼上去:?level=vip;请求头条件写成 -H 'X-Token: abc' |
| 条件响应 | 每条条件响应各一个 | 同上,按这条响应自己的条件拼 |
| 数据集·分页 / 搜索 / 排序 / 取字段 / 单条 / 过滤 | 响应绑了数据集 | ?page=1&pageSize=10、?q=phone、?sortBy=id&order=desc、?select=id、/1、?category=xxx |
| 序列·第 2 次调用 | 配了多条响应序列 | 地址不变,说明连着调会依次返回序列里的第 N 条 |
两点注意:一是 POST / PUT / PATCH 的参数条件会放进请求体而不是查询串(跟真实调用一致);二是「不等于 / 正则 / 不传」这类条件给不出不会误导的示例值,示例里不带该参数,只在下面那行小字里写清楚还要满足什么。
描述是接口名称的扩充说明(比如「登录后返回 token,有效期 2 小时」),只给你自己看:不参与匹配,也不会返回给调用方,位置就在接口名称下面。
想看某次调用的请求头 / 请求体 / 响应内容,去「调用日志」页,点那一行的「详情」,直接弹出这一条的完整明细:请求行与 query、请求头、请求体、响应头、响应体,底部只有「复制」(复制整份明细)和「关闭」。想看某条 API 的整体表现,回到「我的 API」列表点它的「统计」。
项目(Project)
项目相当于你账号下的一层分类:一个项目有自己的名称、API 前缀和描述,下面挂着各自的 API 与数据集。建 API 或数据集时选一个项目,它们就归到这个项目下;API 一旦选了项目,调用地址上会自动带上项目前缀。
| 字段 | 说明 |
|---|---|
| 名称 | 随便起,如「订单中心」「支付 mock」 |
| API 前缀 | 路径里的第一段,只能是字母、数字、下划线。可以自己填;留空或填中文会自动转成拼音(如「订单中心」→ ding_dan_zhong_xin)。同一个账号下前缀唯一 |
| 描述 | 给自己看的备注,不参与匹配 |
前缀怎么影响地址
| 场景 | 填写的路径 | 实际调用地址 |
|---|---|---|
| 公开,无项目 | orders | /m/orders |
公开,项目前缀 order | orders | /m/order/orders |
私有,项目前缀 order | orders | /m/u/{你的命名空间}/order/orders |
前缀是服务端渲染时拼上去的,规则里存的还是你填的原始路径,所以列表里看到的地址永远是算好的真实地址,复制即可用。
改前缀 / 删项目
- 改前缀:项目下所有 API 的地址会同步刷新,老地址立即失效(同时改代码里的调用地址即可);
- 删项目:项目下还有 API 或数据集时不允许删除,先把它们移走或删掉。
项目在控制台的「项目」页里管理:新建、改名、改前缀、删除都在那儿;建 API 的表单上有「项目」下拉,留空就是「不归任何项目」。未登录(首页)创建的接口强制不挂项目。