使用 Postman 调试
更新时间: 2024/07/17 17:57:35
Postman 是一款 API 开发和测试工具,提供了一个直观的可视化界面,您可以通过该工具发送 HTTP 请求(如GET、POST、PUT、DELETE 等),并查看服务器的响应。它还提供了一些高级功能,如环境变量、多语言、预定义脚本,通过该工具您能够更好地调试和管理您的 API。
本文介绍如何使用 Postman 调试 Netease IM 即时通讯 RESTful API,我们提供了 Postman Collection 供您调试测试。
该 Postman Collection 仅供调试测试使用,并未包含所有服务端 API,且存在部分参数与 API 参考文档有偏差,请以文档为准。
前提条件
- 已下载并安装 Postman。
- 已经下载并解压 IM Postman Collection。
- 已在云信控制台创建应用,获取 App Key。
- 已了解 API 调用方式。
步骤1 导入并配置环境变量
-
打开 Postman,单击 Import,导入解压后的 Postman Collection 文件夹。
-
导入成功后,单击右上角眼睛图标,然后在 Globals 下单击 Add 添加全局变量。
-
添加 AppKey 和 AppSecret 两个全局变量,并在 CURRENT VALUE 填入在云信控制台获取的 App Key 和 App Secret。
单击 Save 保存配置,在随后请求时,模板会根据填入的 AppKey 和 AppSecret 自动实时计算生成鉴权参数 Nonce、CurTime、CheckSum。
步骤2 开始调试
本节以注册云信IM账号和发送消息接口为例介绍如何使用 Postman 调试 RESTful API。
注册云信IM账号
-
在 Postman 左侧目录选择 IM > 网易云通信ID > 创建网易云通信ID,单击 Send。
-
在下方查看响应内容,若
code
不是 200,请根据响应内容中的desc
排查问题。
发送消息
-
在 Postman 左侧目录选择 IM > 消息功能 > 发送普通消息,单击 Body。
Body 默认为 x-www-form-urlencoded 格式,根据 Key 填入对应 Value,已勾选的 Key 为必填参数。参数详细说明请参考发送消息请求参数。
-
在下方查看响应内容,若
code
不是 200,请根据响应内容中的desc
排查问题。
语言选择
单击 Postman 右侧代码图标,选择您需要的代码语言,即可生成指定语言的示例代码。