Начало работы с Postman и API Discourse

[supermathie (Michael Brown)]

Сводка

Postman — это инструмент для удобного создания и тестирования запросов к API.

Настройка в Discourse

1. После открытия Postman нажмите Создать рабочее пространство:

   

2. Выберите Blank workspace и нажмите Далее.

3. Дайте название Discourse API и нажмите Создать:

   

4. Нажмите Collections:
   

   

5. Нажмите Импорт:
   

   

6. Вставьте https://docs.discourse.org/openapi.json (это URL «Скачать», отображаемый на docs.discourse.org):
   

   

7. Выберите импорт в виде Postman Collection:
   

   

Создание новой среды

1. Нажмите Environments и Create Environment. Здесь будут храниться переменные, специфичные для тестируемого экземпляра. В этом примере мы используем try.discourse.org.

   • Добавьте новую переменную: defaultHost со значением try.discourse.org:
   • Выберите среду try.discourse.org из выпадающего списка ⑤ Environment
   

Hello World!

Попробуем отправить запрос!

1. Выберите Collections → categories.json → Retrieves a list of categories и нажмите Отправить. Вы должны увидеть результат:
   
   

Добавление аутентификации к запросам

Для использования API с аутентификацией по ключу API:

1. Добавьте следующие переменные в эту или новую среду:

   • api-username
   • api-key
   
   
   (их значения, конечно же, должны быть действительными для запрашиваемого сайта)

2. Добавьте скрипт в коллекцию
   Выберите Collections → Discourse API Documentation → Scripts → 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")
   })