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 コレクション としてインポートすることを選択します。
   

   

新しい環境を作成する

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 → スクリプト → 事前リクエスト を選択し、以下を貼り付けます。

   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")
   })