API 端点测试工具
从我们的服务器向公开的 API 端点发送一次请求,查看它返回的 HTTP 状态码、耗时以及是否算作成功。这是确认端点在线并可从互联网访问的快捷方式。
此工具检查什么
状态码
端点在跟随最多 5 次重定向后返回的 HTTP 状态。
响应时间
从我们服务器发出的完整往返时间(毫秒),包括 DNS 查询、建立连接和所有重定向。
成功或失败
最终状态码低于 400 即为成功。超时(15 秒后)、连接失败和被屏蔽的地址会显示为错误。
检查的工作原理
我们的服务器会使用您输入的方法、请求头和请求体发送请求。请求体按输入内容原样发送,因此如果 API 需要 JSON 或表单数据,请添加 Content-Type 请求头。响应体不会显示,也不会保留。
出于安全考虑,只能测试公共互联网地址。私有网络上的地址 — localhost、10.x.x.x、192.168.x.x、云元数据服务等 — 会被屏蔽,每次重定向也会以同样方式检查。
使用测试工具需要免费账户,并且请求按网络限制频率。我们会将端点 URL、方法、状态码、响应时间和任何错误保存到您的账户;请求头和请求体不会保存。
我们常发现的问题
401 或 403
端点需要身份验证,或者发送的密钥或令牌没有权限。
404 Not Found
路径错误、缺少 /v1 之类的版本前缀,或带有 API 不接受的结尾斜杠。
405 Method Not Allowed
端点存在,但不接受此方法 — 例如向只读资源发送 POST。
400 或 415
请求体格式错误,或 Content-Type 请求头缺失或不正确。
429 Too Many Requests
达到了 API 自身的频率限制。
5xx 错误和超时
API 已宕机、负载过高,或响应时间超过 15 秒。
如何修复
发送正确的凭据
按 API 文档规定的格式添加 Authorization 请求头,例如 Authorization: Bearer 后接您的令牌。请使用测试密钥,而不是生产环境的机密信息。
对照文档检查路径
将 URL 与 API 参考文档进行比较,包括版本前缀、结尾斜杠和查询参数。
让请求体与 Content-Type 相符
对于 JSON,请发送有效的 JSON,并附上请求头 Content-Type: application/json。
排查响应缓慢的问题
响应时间长达数秒,通常说明数据库查询缓慢、无服务器托管冷启动,或服务器距离我们的位置较远。
常见问题
为什么我需要账户?
请求是从我们的服务器发送到您选择的地址的。要求使用免费账户并限制请求频率,可以防止测试工具被用来向他人的服务器发送匿名流量。
我可以测试 localhost 或内部 API 吗?
不可以。私有和内部地址是有意屏蔽的,以免测试工具被用来访问我们自己的内部网络。如需测试本地 API,请使用在您自己电脑上运行的工具。
为什么我看不到响应体?
测试工具报告的是端点能否访问以及响应有多快。它不会显示或保留响应内容。
我的 API 密钥会被存储吗?
请求头和请求体会发送到端点,但不会保存。端点 URL 会随结果一起保存,所以请不要在 URL 的查询字符串中放入机密信息。
为什么响应时间与我在本地看到的不同?
它是从我们的服务器而不是您的电脑测量的,因此距离、路由和建立连接的过程都不同。它最适合用来比较同一端点在不同时间的表现。
我可以用它做负载测试吗?
不可以。它每次只发送一个请求,并且有频率限制。请使用专门的负载测试工具,并且只针对您有权测试的服务器。