跳到主要内容

Developer Portal API Test

概述

本教程解释了开发人员如何使用嵌入式测试工具直接从开发者门户测试 API。它支持多种 API 协议,如 REST、GraphQL 和 WebSocket,允许开发人员在不离开门户的情况下与端点进行交互。

先决条件

  • 目标 API 必须已部署并发布到网关
  • API 必须是可在开发者门户上可见的产品的一部分
  • 您必须登录到开发者门户并访问 API 产品

测试 REST API

  • 从产品详细信息页面选择一个 API
  • 转到 API 的测试选项卡

示例:

字段示例值
方法GET
URLhttps://echo.hoppscotch.io
头部可选(例如,Authorization: Bearer token
查询参数根据需要添加

点击发送并观察响应体、状态码和头部

测试 GraphQL API

query Request {
method
url
headers {
key
value
}
}

点击连接,然后执行您的查询

测试 WebSocket API

  • 选择 WebSocket 选项卡
  • 输入 WebSocket 端点(例如,wss://echo-websocket.hoppscotch.io)
  • 点击连接
  • 发送 JSON 格式的测试消息:
{
"message": "Hello WebSocket"
}

查看服务器返回的实时响应

最佳实践

  • 在尝试公共 API 时使用测试环境或模拟服务器
  • 对于经过身份验证的 API,请手动提供头部或令牌
  • 如果可用,请使用 GraphQL 反射自动加载架构
  • 对于 WebSocket,逐步测试握手和消息协议