API 端点检查器

可选的响应检查

留空即可跳过相应检查。响应头被隐藏或响应体无法读取时,结果为“无法判断”,而非“未通过”。

CORS 决定此页面能读取哪些响应和响应头。目标服务器会收到请求和您的 IP 地址。

状态
时长
ms
字节
重定向后的最终 URL:
预览在 1 MiB 处停止。端点可能还返回了更多数据。

响应检查结果

单次请求的脱敏报告

下载文件包含请求方法、脱敏后的端点、最终状态码、耗时和检查结果;不包含 URL 路径与查询参数、请求头与请求体、响应体或响应头的值。

从浏览器发送 GET、HEAD、POST、PUT、PATCH 或 DELETE 请求,并查看最终响应。您可以设置可选检查,验证状态码或状态码范围、浏览器可读取的响应头及 JSON 属性。每项检查会显示“通过”“未通过”或“无法判断”。工具显示最终状态码、收到响应头前的耗时、浏览器可读取的响应头,以及最多 1 MiB 的响应文本。只有您选择“发送请求”后,工具才会发送请求。

如何检查 API 端点

  1. 1

    填写请求

    输入 HTTP 或 HTTPS URL 并选择请求方法。如果端点需要,可添加请求头或请求体。GET 和 HEAD 不会发送填写的请求体。

  2. 2

    设置可选的预期结果

    可填写 `200` 等状态码、`200-204` 等范围或 `2xx` 等类别。也可以输入响应头名称和 JSON 路径,并分别指定可选的预期值。留空即可跳过相应检查。

  3. 3

    发送请求并查看结果

    选择一次“发送请求”,查看最终状态码和各项检查结果。响应头被隐藏、响应无法读取或 JSON 响应体不完整时,检查可能显示“无法判断”。

  4. 4

    保存脱敏报告

    下载此次检查的文本或 JSON 报告。报告记录端点来源、请求方法、最终状态码、耗时和检查结果,但省略 URL 路径与查询参数、请求内容及响应内容。

响应检查示例

假设您自己的 GET https://api.example.com/health 端点返回状态码 200、浏览器可读取的响应头 Content-Type: application/json,以及 {"status":"ready"}。您可以填写:

可选字段 示例 检查内容
预期状态码 200, 204 或 2xx 最终状态码是否在指定范围内。
响应头名称 Content-Type 浏览器能否读取此响应头。
预期响应头值 application/json 可读取的值是否完全匹配。留空则只检查能否读取。
JSON 属性路径 $.status 完整的 JSON 响应中是否存在该属性。
预期 JSON 值 "ready" 解析后的 JSON 值是否匹配。留空则只检查属性是否存在。

JSON 值字段采用 JSON 语法:布尔值填 true,数字填 42,字符串填 "ready"。路径以 $ 开头,支持属性和数组索引,例如 $.data.items[0].id。路径不会运行脚本,也不支持筛选器。如果可读取的 JSON 中缺少该属性,检查结果为 未通过。响应头不存在或被 CORS 隐藏时,结果为 无法判断,因为浏览器无法区分这两种情况。

检查结果说明

结果 含义
通过 浏览器可读取的最终响应满足该项预期。
未通过 可读取的最终响应与预期不符,或缺少指定的 JSON 属性。
无法判断 浏览器无法确定结果,例如无法读取响应、响应头不存在或被隐藏,或者 JSON 响应体为空、不完整或无效。

计时在收到响应头时停止,不包括下载完整响应体的时间。请求在 15 秒后超时;请求体上限为 1 MiB,响应预览在 1 MiB 处停止。预览被截断时,无法据此判断 JSON 属性。HEAD 和 204 响应没有可检查的响应体,因此 JSON 检查会显示“无法判断”。工具会跟随重定向并显示最终 URL,但不会列出每次跳转,也不会自动重复请求。即使端点收到了请求,浏览器的 CORS 规则仍可能阻止页面读取响应。浏览器也可能在发送所选方法的请求前发起 CORS 预检请求。

只能检查浏览器可读取的响应头。对于自定义响应头,端点可能需要在 Access-Control-Expose-Headers 中列出其名称。页面上看不到某个响应头,可能是服务器没有返回,也可能只是 CORS 将其隐藏。如果需要区分,请查看服务器日志或使用合适的 API 客户端。

常见问题

“未通过”表示浏览器可读取的响应与您的预期不符。“无法判断”表示浏览器无法确定结果。例如,浏览器无法判断看不到的响应头究竟不存在还是被 CORS 隐藏;响应体为空、无法读取或被截断时,也无法检查 JSON。

如果端点通过 CORS 允许此浏览器请求,您可以填写 Authorization 请求头。检查器不会附带浏览器 Cookie 或其他已有凭据。请求头的值会直接发送到目标服务器,因此只应对可信端点使用凭据。

浏览器会将请求直接发送到目标服务器,目标服务器会收到请求和您的 IP 地址。您输入的 URL、请求头和请求体不会经过本站服务器,也不会出现在工具页面的 URL 中。脱敏报告会保留端点来源,但不会包含 URL 的其余部分、请求头或请求体。为了在步骤间切换,工具会将您输入的内容短暂保存在当前标签页的会话存储中。保存的记录最多只在五分钟内被接受,读取后、您重新开始时或检查完成后便会删除。同一网站的脚本可以在记录存在期间读取它。如果浏览器阻止存储,您仍可在当前页面发送请求。

工具会为当前检查生成一份文本或 JSON 报告。报告包含端点来源、请求方法、最终状态码、收到响应头前的耗时、已读取的字节数、重定向和截断标记,以及检查结果。报告不包含 URL 路径、查询参数和片段、请求头及其值、请求体、响应头及其值或响应体。分享前请检查文件,因为端点来源和检查结果仍可能暴露您的服务信息。

计时从浏览器开始执行 Fetch 前立即启动,到收到最终响应头时停止。它包含浏览器和网络开销及允许的重定向,但不包含读取响应体的时间。服务器日志可能测量的是另一段时间。

不会。每次选择“发送请求”才会运行一次检查。工具不会安排定时任务、自动重复或持续监控请求。不过,一次检查可能因 CORS 预检和跟随重定向而产生额外的网络请求。

相关工具

此工具还提供其他语言版本