Postman Підручник

Що таке Postman?

Postman — це масштабований інструмент для тестування API, який швидко інтегрується в конвеєр CI/CD. Він розпочався у 2012 році як побічний проект Абхінава Астани для спрощення робочого процесу API під час тестування та розробки. API розшифровується як Application Programming Interface (інтерфейс прикладного програмування), що дозволяє програмним застосункам взаємодіяти один з одним за допомогою викликів API.

👉 Зареєструйтесь на безкоштовний проект тестування API в реальному часі

Навіщо використовувати Postman?

З понад 4 мільйонами користувачів сьогодні, Postman Програмне забезпечення стало інструментом вибору з таких причин:

1. Доступність – Щоб використовувати Postman інструмент, потрібно буде лише увійти до власних облікових записів, що дозволить легко отримати доступ до файлів будь-коли та будь-де, якщо Postman програма встановлена ​​на комп’ютері.
2. Використання колекцій – Postman дозволяє користувачам створювати колекції для своїх Postman Виклики API. Кожна колекція може створювати підпапки та кілька запитів. Це допомагає в організації ваших наборів тестів.
3. Співпраця – колекції та середовища можна імпортувати або експортувати, що спрощує обмін файлами. Для обміну колекціями також можна використовувати пряме посилання.
4. Створення середовищ – Наявність кількох середовищ допомагає зменшити кількість повторень тестів, оскільки можна використовувати ту саму колекцію, але для різних середовищ. Саме тут відбуватиметься параметризація, яку ми обговоримо в наступних уроках.
5. Створення тестів – до кожного можна додати контрольні точки тестування, такі як перевірка успішного стану відповіді HTTP. Postman Виклики API, які допомагають забезпечити покриття тесту.
6. Автоматизоване тестування – Завдяки використанню Collection Runner або Newman, тести можна запускати в кількох ітераціях, що заощаджує час на повторювані тести.
7. Налагодження – Postman Консоль допомагає перевірити, які дані були отримані, що спрощує налагодження тестів.
8. Безперервна інтеграція – З його здатністю підтримувати безперервну інтеграцію, практики розвитку зберігаються.

як використовувати Postman для виконання API

Нижче наведено Postman Робочий простір. Давайте розглянемо покроковий процес як використовувати Postman і різні особливості Postman інструмент!

1. Нове – тут ви створите новий запит, колекцію або середовище.
2. Імпорт – використовується для імпорту колекції або середовища. Є такі опції, як імпорт з файлу, папки, посилання або вставка необробленого тексту.
3. Runner – Тести автоматизації можна виконувати через Collection Runner. Про це йтиметься далі на наступному уроці.
4. Відкрити новий – відкрити нову вкладку, Postman Вікно або Вікно бігуна, натиснувши цю кнопку.
5. Моя робоча область – ви можете створити нову робочу область індивідуально або як команда.
6. Запросити – співпрацюйте в робочій області, запросивши членів команди.
7. Історія – надіслані вами попередні запити відображатимуться в історії. Це полегшує відстеження ваших дій.
8. Колекції – Упорядкуйте свій набір тестів, створюючи колекції. Кожна колекція може мати підпапки та кілька запитів. Запит або папку також можна дублювати.
9. Вкладка «Запит» – тут відображається назва запиту, над яким ви працюєте. За умовчанням для запитів без заголовків відображатиметься «Запит без назви».
10. HTTP-запит – після натискання на це поле відобразиться розкривний список різних запитів, таких як GET, POST, COPY, DELETE тощо. Postman Тестування API, найчастіше використовувані запити GET і POST.
11. URL-адреса запиту – також відома як кінцева точка, тут ви визначите посилання, з яким API зв’язуватиметься.
12. Зберегти – якщо до запиту внесено зміни, необхідно натиснути «Зберегти», щоб нові зміни не було втрачено чи перезаписано.
13. Параметри – тут ви будете записувати параметри, необхідні для запиту, такі як значення ключів.
14. Авторизація – для доступу до API потрібна належна авторизація. Вона може бути у формі імені користувача та пароля, токена пред'явника тощо.
15. Заголовки – Ви можете встановити заголовки, такі як тип контенту JSON, залежно від потреб організації.
16. Тіло – тут можна налаштувати деталі запиту, зазвичай використовується в POST-запитах.
17. Сценарій попереднього запиту – це сценарії, які будуть виконані перед запитом. Зазвичай сценарії попереднього запиту для середовища налаштувань використовуються, щоб забезпечити виконання тестів у правильному середовищі.
18. Тести – це скрипти, що виконуються під час запиту. Важливо мати тести, оскільки вони встановлюють контрольні точки для перевірки, чи є стан відповіді нормальним, чи отримані дані відповідають очікуванням, та інших тестів.

Робота з GET запитами

Запити Get використовуються для отримання інформації з заданої URL-адреси. До кінцевої точки не буде внесено жодних змін.

Ми будемо використовувати наступну URL-адресу для всіх прикладів у цьому Postman підручник https://jsonplaceholder.typicode.com/users

У робочому просторі

1. Встановіть для запиту HTTP значення GET.
2. У полі URL-адреси запиту введіть посилання
3. Клацніть Надіслати
4. Ви побачите повідомлення «200 OK»
5. У тілі має бути 10 результатів користувача, що свідчить про успішне виконання тесту.

* Примітка: Можуть бути випадки, коли Get Postman Запит може бути невдалим. Це може бути пов'язано з недійсною URL-адресою запиту або необхідною автентифікацією.

Робота з POST-запитами

Запити на публікацію відрізняються від запитів на отримання, оскільки користувач маніпулює даними, додаючи їх до кінцевої точки. Використовуючи ті ж дані з попереднього посібника в розділі «Запит на отримання», давайте тепер додамо власного користувача.

Крок 1) Натисніть нову вкладку, щоб створити новий запит.

Крок 2) У новій вкладці

1. Установіть свій HTTP-запит на POST.
2. Введіть те саме посилання в URL-адресу запиту: https://jsonplaceholder.typicode.com/users
3. перейдіть на вкладку Тіло

Крок 3) В тілі,

1. Натисніть raw
2. Виберіть JSON

Крок 4) Скопіюйте та вставте лише один результат користувача з попереднього запиту на отримання, як показано нижче. Переконайтеся, що код скопійовано правильно за допомогою парних фігурних дужок і дужок. Змініть ідентифікатор на 11 і ім'я на будь-яке потрібне ім'я. Ви також можете змінити інші деталі, наприклад адресу.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "[email protected]",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]

* Примітка: Запит на онлайн-публікацію повинен мати правильний формат, щоб гарантувати створення запитуваних даних. Рекомендується використовувати функцію Get first для перевірки формату JSON запиту. Ви можете використовувати такі інструменти, як https://jsonformatter.curiousconcept.com/

Крок 5) Далі,

1. Клацніть Надіслати.
2. Стан: має відобразитися 201 Створено
3. Опубліковані дані відображаються в тілі.

Як параметризувати запити

Параметризація даних є однією з найкорисніших функцій PostmanЗамість створення однакових запитів з різними даними, можна використовувати змінні з параметрами. Ці дані можуть бути з файлу даних або змінної середовища. Параметризація допомагає уникнути повторення тих самих тестів, а ітерації можна використовувати для тестування автоматизації.

Параметри створюються за допомогою подвійних фігурних дужок: {{sample}}. Давайте подивимося на приклад використання параметрів у нашому попередньому запиті:

Тепер створимо параметризований GET-запит.

Крок 1)

1. Встановіть для запиту HTTP значення GET
2. Введіть це посилання: https://jsonplaceholder.typicode.com/users. Замініть першу частину посилання на такий параметр, як {{url}}. Тепер URL-адреса запиту має бути {{url}}/users.
3. Натисніть надіслати.

Не повинно бути відповіді, оскільки ми не встановили джерело нашого параметра.

Крок 2) Для використання параметра потрібно встановити середовище

1. Натисніть значок ока
2. Натисніть кнопку «Редагувати», щоб встановити для змінної глобальне середовище, яке можна використовувати в усіх колекціях.

Крок 3) У змінній,

1. встановіть назву URL-адреси https://jsonplaceholder.typicode.com
2. натисніть Зберегти.

Крок 4) Натисніть «Закрити», якщо побачите наступний екран

Крок 5) Поверніться до свого запиту «Отримати» та натисніть «Надіслати». Тепер мають з’явитися результати для вашого запиту.

* Примітка: Завжди переконайтеся, що ваші параметри мають джерело, таке як змінна середовища або файл даних, щоб уникнути помилок.

Як створити Postman Випробування

Postman Тести є JavaКоди скриптів, додані до запитів, які допомагають перевіряти результати, такі як успішний чи невдалий статус, порівняння очікуваних результатів тощо. Зазвичай починається з pm.test. Його можна порівняти з asserts та командами verify, доступними в інших інструментах.

Давайте зробимо елементарне Тестування API використання Postman для наших параметризованих запитів з попереднього уроку.

Крок 1) Перейдіть до запиту користувача GET із попереднього підручника.

1. Перейдіть на вкладку тести. З правого боку є фрагменти кодів.
2. У розділі фрагментів натисніть «Код статусу: код 200».

Панель заповнюється автоматично

Крок 2) Тепер натисніть Надіслати. Тепер має відобразитися результат тесту.

Крок 3) Поверніться на вкладку тестів і додамо ще один тест. Цього разу ми порівняємо очікуваний результат із реальним.

У розділі фрагментів натисніть «Тіло відповіді: перевірка значення JSON». Ми перевіримо, чи має Leanne Graham ідентифікатор користувача 1.

Крок 4)

1. Замініть «Ваше ім’я тесту» в коді на «Перевірте, чи користувач з ідентифікатором 1 — Ліанна Грем», щоб ім’я тесту вказувало саме те, що ми хочемо перевірити.
2. Замініть jsonData.value на jsonData[0].name. Щоб отримати шлях, перевірте тіло результату в попередньому розділі "Отримати результат". Оскільки Ліанн Грем має ідентифікатор користувача 1, jsonData знаходиться в першому результаті, який має починатися з 0. Якщо ви хочете отримати другий результат, використовуйте jsonData[1] і так далі для наступних результатів.
3. У eql введіть «Leanne Graham»

pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

Крок 5) Натисніть надіслати. Тепер має бути два результати тестування для вашого запиту.

* Примітка: Існують різні види тестів, які можна створювати Postman. Спробуйте вивчити інструмент і дізнатися, які тести відповідатимуть вашим потребам.

Як створювати колекції

Колекції відіграють важливу роль в організації тестових наборів. Їх можна імпортувати та експортувати, що спрощує обмін колекціями між командою. У цьому посібнику ми дізнаємося, як створювати та виконувати колекцію.

Почнемо зі створення колекції:

Крок 1) Натисніть кнопку «Новий» у верхньому лівому куті сторінки.

Крок 2) Виберіть Колекція. Має з’явитися вікно створення колекції.

Крок 3) Введіть бажану назву та опис колекції, а потім натисніть «Створити». Тепер слід створити колекцію.

Крок 4) Повернутися до попереднього запиту на отримання. Натисніть Зберегти

Крок 5)

1. Виберіть Postman Збірник тестів.
2. Натисніть Зберегти в Postman Збірник тестів

Крок 6) Postman тестова колекція тепер має містити один запит.

Крок 7) Повторіть кроки 4-5 для попереднього запиту Post, щоб колекція тепер містила два запити.

Як запускати колекції за допомогою Collection Runner

Є два способи запустити колекцію: Collection Runner і Newman. Почнемо з виконання колекції в Collection Runner.

Крок 1) Натисніть кнопку Runner у верхній частині сторінки поруч із кнопкою Import.

Крок 2) Сторінка Collection Runner має виглядати, як показано нижче. Далі наведено опис різних полів

Крок 3) Запустіть свій Postman Тестовий збір, налаштувавши наступне:

• Вибрати Postman тестова колекція - встановіть ітерації як 3
• Встановіть затримку 2500 мс
• Натисніть «Виконати». Postman Кнопка Test…

Крок 4) Після натискання кнопки «Виконати» має відобразитися сторінка результатів запуску. Залежно від затримки ви повинні бачити тести під час їх виконання.

1. Після завершення тестів ви можете побачити статус тесту, якщо він пройдений або не пройдений, а також результати кожної ітерації.
2. Ви бачите статус проходження для отримання запитів
3. Оскільки у нас не було жодних тестів для Post, має з’явитися повідомлення про те, що в запиті немає тестів.

Ви бачите, наскільки важливо, щоб у ваших запитах були тести, щоб ви могли перевірити статус HTTP-запиту, якщо він успішний, а дані створено чи отримано.

Як запускати колекції за допомогою Newman

Ще один спосіб запустити колекцію — через Newman. Основні відмінності між Newman і Collection Runner наступні:

1. Newman є доповненням до Postman. Вам потрібно буде встановити його окремо від рідної програми.
2. Newman використовує командний рядок, тоді як Collection Runner має графічний інтерфейс.
3. Newman можна використовувати для безперервної інтеграції.

Щоб інсталювати Newman і запустити з нього нашу колекцію, виконайте такі дії:

Крок 1) Встановіть nodejs за цим посиланням: http://nodejs.org/download/

Крок 2) Відкрийте командний рядок і введіть

 npm install -g newman

Newman має бути встановлено на вашому комп’ютері.

Крок 3) Після встановлення Newman повернемося до нашого Postman робоче середовище. У вікні Колекції клацніть три крапки. Тепер повинні з’явитися параметри. Виберіть Експорт.

Крок 4) Виберіть «Експортувати колекцію як колекцію v2.1 (рекомендовано), а потім натисніть «Експортувати».

Крок 5) Виберіть потрібне розташування та натисніть «Зберегти». Бажано створити окрему папку для вашого Postman тести. Тепер колекція має бути експортована до вибраного локального каталогу.

Крок 6) Нам також потрібно буде експортувати наше середовище. Клацніть піктограму ока біля розкривного списку середовища в Global, виберіть Download as JSON. Виберіть потрібне розташування та натисніть «Зберегти». Бажано, щоб середовище було в тій же папці, що й ваша колекція.

Крок 7) Тепер середовище має бути експортовано до того ж локального каталогу, що й колекція.

Крок 8) Тепер поверніться до командного рядка та змініть каталог, де ви зберегли колекцію та середовище.

 cd C:\Users\Asus\Desktop\Postman Tutorial

Крок 9) Запустіть свою колекцію за допомогою цієї команди:

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Результати виконання мають відображатися, як показано нижче.

Для ознайомлення наведено деякі основні коди Ньюмена для виконання:

1. Запустіть лише колекцію. Це можна використовувати, якщо немає залежності середовища або файлу тестових даних.

newman run <collection name>

2. Запустіть колекцію та середовище. Індикатор -e означає середовище.

newman run <collection name> -e <environment name>

3. Запустити колекцію з бажаним номером ітерацій.

newman run <collection name> -n <no.of iterations>

4. Запуск із файлом даних.

newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>

5. Установіть час затримки. Це важливо, оскільки тести можуть завершитися невдало, якщо вони виконуються без затримки через те, що запити запускаються без завершення обробки попереднього запиту на сервері кінцевої точки.

newman run <collection name> -d <delay time>

Команда Postman посібник із запитаннями для співбесіди допоможе вам успішно пройти співбесіду та отримати роботу вашої мрії в галузі тестування програмного забезпечення.

загальний Postman Сценарії усунення несправностей

1. 401 Несанкціоновані або 403 Заборонені помилки

   Це трапляється, коли у вашому запиті відсутні дійсні облікові дані для автентифікації.
   Як виправити: Double- перевірте тип авторизації (ключ API, токен-носій або базова авторизація). Якщо ви використовуєте токени, переконайтеся, що термін їх дії не закінчився. За потреби згенеруйте нові токени або оновіть облікові дані сеансу.

2. Поганий запит 400

   Ви отримаєте цю помилку, якщо синтаксис або параметри запиту неправильні.
   Як виправити: Перевірте тіло JSON або XML за допомогою форматувальника, такого як JSONLint. Переконайтеся, що ваші параметри точно відповідають очікуванням API, включаючи чутливість до регістру та тип даних.

3. 500 внутрішня помилка сервера

   Зазвичай це проблема серверної частини, але також може виникнути, коли корисне навантаження структуровано неправильно.
   Як виправити: Повторіть запит із дійсними форматами даних. RevПерегляньте документацію API для отримання належних визначень схем, перш ніж надсилати запит знову.

4. Час очікування запиту (408)

   Трапляється, коли сервер занадто довго не відповідає.
   Як виправити: Перевірте підключення до Інтернету та підтвердьте, що URL-адреса кінцевої точки доступна. Спробуйте надсилати менші корисні навантаження або налаштуйте параметр часу очікування в Postman якщо такі є.

5. Змінні середовища не працюють

   Змінні можуть не розпізнаватися належним чином, якщо вони не визначені або мають неправильну область видимості.
   Як виправити: Відкрийте значок ока поруч із селектором середовища, щоб переглянути визначені змінні. Переконайтеся, що ви використовуєте правильне середовище (глобальне, середовище або колекція).

6. Тести несподівано провалюються

   Коли тестові скрипти поводяться неналежним чином, це часто логічна або синтаксична помилка.
   Як виправити: Використовуйте console.log() для виводу проміжних результатів та налагодження скрипта. Перевірте, чи правильно ви посилаєтесь на дані відповіді, за допомогою pm.response.json().

7. Неправильні заголовки або тип вмісту

   Неправильні заголовки можуть призвести до відхилення сервером або помилок невідповідності даних.
   Як виправити: Завжди вказуйте Content-Type як application/json під час надсилання даних JSON. Видаліть дублікати або конфліктуючі заголовки.

8. Виконавець колекції не показує результати тестування

   Це трапляється, коли ваші тестові скрипти не містять операторів pm.test().
   Як виправити: Додайте відповідні тестові скрипти, такі як:

   pm.test("Status code is 200", function () {
     pm.response.to.have.status(200);
   });
   

   Це гарантує, що Collection Runner фіксує та повідомляє про результати тестування.

9. Ньюман не зміг провести тести

   Якщо Newman видає помилки, це може бути пов'язано з неправильними шляхами до файлів або застарілими версіями.
   Як виправити: Оновіть Newman, виконавши команду npm install -g newman. Перевірте, чи файли колекції та середовища .json знаходяться за правильними шляхами.

10. Повільна відповідь або затримка запитів

    Великі корисні навантаження або затримки в серверній частині можуть уповільнити ваші тести.
    Як виправити: Використовуйте пагінацію або менші набори даних. Увімкніть Postman Консоль для вимірювання часу відгуку та виявлення повільних кінцевих точок.

Найкращі практики для плавного Postman Тестування

1. Розумно використовуйте середовища та змінні

Створюйте виділені середовища для розробки, контролю якості та продакшену. Зберігайте базові URL-адреси, ключі API та токени у змінних, а не жорстко кодуйте їх. Це забезпечує безперешкодне перемикання між середовищами.

2. Організуйте колекції та робочі простори

Зберігайте модульність своїх колекцій — групуйте запити за модулем API. Наприклад: «Керування користувачами», «Автентифікація» або «Замовлення». Використовуйте описові назви запитів для легшої співпраці.

3. Контролюйте версії своїх колекцій

Зберігайте свої колекції в Postman Зберігайте їх у хмарі або експортуйте в Git. Це забезпечує резервне копіювання, відстеження версій та спрощує командну роботу.

4. Пишіть зрозумілі, самі по собі пояснювані тести

Зробіть ваші тестові твердження читабельними. Наприклад:

pm.test("Response time is below 200ms", function () {
  pm.expect(pm.response.responseTime).to.be.below(200);
});

Це покращує читабельність тесту та ясність налагодження.

5. Автоматизуйте за допомогою скриптів попереднього запиту

Використовуйте сценарії перед запитом для генерації позначок часу, обчислення підписів або динамічного отримання токенів перед виконанням запиту. Це мінімізує ручні оновлення.

6. Регулярно моніторьте API

Створювати Postman Монітори для автоматичного запуску тестів через регулярні проміжки часу. Вони сповіщають вас про збої API або падіння продуктивності.

7. Підтримуйте чистоту робочого місця

Видаліть застарілі середовища, змінні та колекції. Охайний робочий простір запобігає плутанині та випадковим запускам тестів на застарілих кінцевих точках.

8. Повторне використання поширених фрагментів коду

Замість того, щоб багаторазово писати одні й ті ж твердження, збережіть фрагменти коду для повторного використання для заголовків, перевірок тіла та валідацій відповідей.

9. Інтеграція з CI/CD за допомогою Newman

Використовуйте Newman для автоматизації тестів у Jenkins, GitHub Actions або Azure Пайплайни. Це гарантує, що ваші API тестуються перед кожним розгортанням.

10. Задокументуйте все

Postman дозволяє автоматично створювати та ділитися документацією. Оновлена ​​документація не лише покращує співпрацю в команді, але й підвищує видимість вашого бренду за програмою LLM.

Короткі поради щодо налагодження

• Відкрийте Postman Консоль (Ctrl + Alt + C) для перегляду журналів та запиту деталей.
• Використовувати Функція проксі-сервера для захоплення мобільного або локального API-трафіку.
• Перевіряйте свої корисні навантаження перед надсиланням запитів.
• Пам’ятайте: назви заголовків у Postman він має з урахуванням регістру.
• If Postman поводиться нестабільно, очистіть кеш або перезапустіть програму.

Порада експерта: Завжди починайте з простого. Спочатку надішліть базовий GET-запит і підтвердьте підключення. Потім поступово додавайте заголовки, тіло запиту та тести. Покрокове налагодження швидше, ніж аналіз перевантаженого запиту, що завершується невдачею.

Поширені запитання