调试 API
开发者门户包括内置的 API 测试功能,可让你直接从浏览器向 API 端点发送请求。这有助于你在将 API 集成到应用程序之前探索和验证它们。
先决条件
发送测试请求
- 登录开发者门户。
- 导航至 API 中心并选择 API 产品。
- 浏览到你要测试的端点。
- 单击“试用”(或“测试请求”)。
- 身份验证类型会根据你的凭证预先选择。如果 API 产品支持多种身份验证类型,请选择与你的凭证匹配的类型。
- 你的凭证会自动填充(例如,API 密钥或基本身份验证凭证)。
- 配置请求参数:
| 参数 | 描述 |
|---|---|
| 路径参数 | 填写所需的 URL 路径段。 |
| 查询参数 | 添加查询字符串参数。 |
| 标题 | 添加或修改请求标头。 |
| 请求正文 | 输入 POST、PUT 和 PATCH 请求的请求正文。 |
- 单击“发送”。
查看响应
发送请求后,门户显示:
- 状态码:HTTP 响应状态(例如 200、401、404)。
- 响应标头:服务器返回的 HTTP 标头。
- 响应正文:响应负载,格式化以提高可读性。
故障排除
CORS 错误
从浏览器测试 API 时,你可能会遇到 CORS(跨源资源共享)错误。发生这种情况是因为浏览器强制执行 CORS 限制并发送预检 OPTIONS 请求。如果网关路由不允许 OPTIONS 方法或未启用 CORS 插件,则浏览器会阻止该请求。
要解决 CORS 错误:
- 要求 API 提供商在相关路由或全局上启用
cors插件。 - 如果全局配置了 CORS 插件,预检
OPTIONS请求会自动处理。
身份验证错误
如果你收到 401 Unauthorized 响应:
- 验证你的订阅是否处于活动状态(未等待批准)。
- 验证你的凭证类型是否与 API 产品的身份验证类型匹配。
- 如果使用 OAuth,请验证你的访问令牌未过期。
- 如果使用密钥身份验证,请验证 API 密钥是否正确且尚未重新生成。
端点未找到
如果你收到 404 Not Found 回复:
- 验证端点路径是否与 API 文档匹配。
- 验证
Host标头是否与链接服务上配置的主机之一匹配。 - 检查 HTTP 方法是否与端点规范匹配。