开始使用 Postman 与 Discourse API

[supermathie (Michael Brown)]

摘要

Postman 是一个方便的工具，用于轻松构建和测试 API 请求。

使用 Discourse 进行配置

1. 打开 Postman 后，点击 “创建工作区”：

   

2. 选择“空白工作区”并点击“下一步”。

3. 标题为“Discourse API”并选择“创建”：

   

4. 点击“集合”：
   

   

5. 点击“导入”：
   

   

6. 粘贴 https://docs.discourse.org/openapi.json（这是 docs.discourse.org 上显示的“下载”URL）：
   

   

7. 选择导入为“Postman Collection”：
   

   

创建新环境

1. 点击“环境”和“创建环境”。这将保存特定于您正在测试的实例的变量。在此示例中，我们将使用 try.discourse.org。

   • 添加一个新变量：“defaultHost”，值为 try.discourse.org：
   • 从“环境”下拉菜单中选择 try.discourse.org 环境
   

Hello World！

让我们尝试一个请求！

1. 选择“集合”→“categories.json”→“检索类别列表”并点击“发送”。您应该会看到结果：
   
   

向请求添加身份验证

要使用 API 密钥身份验证来使用 API：

1. 将以下变量添加到此环境或新环境中：

   • api-username
   • api-key
   
   
   （当然，它们的值必须对于您查询的站点是有效的）

2. 向集合添加脚本
   选择“集合”→“Discourse API Documentation”→“脚本”→“Pre-request”并粘贴以下内容：

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })