Підручник з POSTMAN: Тестування API за допомогою POSTMAN

postman tutorial api testing using postman

Цей покроковий посібник пояснює тестування API за допомогою POSTMAN, включаючи основи роботи POSTMAN, його компоненти та запит та відповідь на вибірку:

Ми подивились найчастіше запитувані Запитання щодо інтерв’ю ASP.Net та Web API у нашому попередньому уроці. Пройшовши цей посібник, ви дізнаєтесь, як ми підходимо до тестування API через POSTMAN для будь-якої заданої URL-адреси.

Листоноша - це дуже простий та інтуїтивно зрозумілий інструмент або програма для тестування API. Кожен компонент у програмі POSTMAN дуже важливий, оскільки він має своє значення.

=> Прочитайте повну серію тестування API тут .

найкращий інструмент скріншоту для Windows 10

Перелік усіх підручників листоноші цієї серії

Підручник No1: Вступ листоноші (Цей підручник)
Підручник No2: Як використовувати листоношу для тестування форматів API Diff
Підручник No3: Листоноша: Змінні сфери та файли навколишнього середовища
Підручник No4: Колекції листонош: імпорт, експорт та створення зразків коду
Підручник No5: Автоматизація перевірки відповідей за допомогою тверджень
Підручник No6: Листоноша: попередній запит та сценарії запитів
Підручник No7: Листоноша Розширені сценарії
Підручник No8: Листоноша - інтеграція командного рядка з Newman
Підручник No9: Листоноша - Шаблони звітування з Ньюменом
Підручник No10: Листоноша - Створення документації API
Підручник No11: Питання інтерв’ю листоноші

Огляд підручників у серії «Листоноша»

Що ви дізнаєтесь:

• ПОЧТАН Вступ
• Встановлення поштової пошти
  • Рідна програма Листоноша
  • Альтернативний короткий посібник із встановлення листоноші
  • Будівельні блоки ПОСТМАН
    • # 1) Запит
    • # 2) Колекція
    • # 3) Навколишнє середовище
  • Збереження запиту в колекції
• Зразок запиту та відповіді
• Оновлення: Додаткова інформація
  • Що таке API?
  • Клієнт ПОСТМАН
    • Як завантажити клієнта POSTMAN?
  • Зателефонуйте REST API за допомогою клієнта POSTMAN
    • # 1) ОТРИМАТИ дзвінок
    • # 2) POST дзвінок
    • # 3) PUT дзвінок
    • # 4) Видалити дзвінок
  • Проблеми в тестуванні API
• Висновок
  • Рекомендована література

ПОЧТАН Вступ

POSTMAN - це клієнт API, який використовується для розробки, тестування, спільного використання та документування API. Він використовується для бекенд-тестування, де ми вводимо URL-адресу кінцевої точки, він відправляє запит на сервер і отримує відповідь назад із сервера. Те саме можна зробити за допомогою шаблонів API, таких як Swagger. І в Swagger, і в POSTMAN нам не потрібно будувати фреймворк (на відміну від Parasoft) для отримання відповіді від служби.

Це основна причина, через яку розробники та інженери-автоматизатори часто використовують POSTMAN, щоб гарантувати, що служба працює та працює разом із версією збірки API, який розгортається в регіоні.

По суті, це допомагає вражати кінцеві точки API, швидко створюючи запити відповідно до специфікації API та розбираючи різні параметри відповіді, такі як код стану, заголовки та власне тіло відповіді.

Ось відеоурок:

Листоноша пропонує безліч розширених функцій, таких як:

• Розробка API.
• Налаштування фіктивних кінцевих точок для API, які все ще розробляються.
• Документація API.
• Твердження щодо відповідей, отриманих від виконання кінцевої точки API.
• Інтеграція з інструментами CI-CD, такими як Jenkins, TeamCity тощо.
• Автоматизація виконання тестів API тощо

Тепер ми пройшли офіційне представлення інструменту, перейдемо до інсталяційної частини.

Встановлення поштової пошти

Листоноша доступний у 2 варіантах.

1. Як додаток для Chrome (це вже застаріло і не підтримується розробниками поштарки)
2. Власна програма для різних платформ, таких як Windows, Mac OS, Linux тощо.

Оскільки програми Chrome застаріли і тісно пов’язані з браузером Chrome (у деяких випадках фактична версія браузера), ми зосередимось переважно на власному додатку, який дає нам більше контролю та має менші зовнішні залежності.

Рідна програма Листоноша

Програма Postman Native - це автономна програма, доступна для завантажити на різних платформах ОС, таких як Windows, Mac OS, Linux тощо. Її можна завантажити, як і будь-яку іншу програму, залежно від платформи користувача.

Процес установки також досить простий. Вам просто потрібно двічі клацнути на завантаженому програмі встановлення (для Windows та Mac) і слідувати інструкціям.

Після успішного встановлення просто відкрийте програму Поштовик, щоб розпочати.

Ми побачимо, як створити простий запит для будь-якого доступного API з відкритим кодом, і побачимо різні компоненти запиту та відповіді, отримані, коли запит виконується за допомогою програми Postman.

Настійно рекомендуємо входити в систему / реєструватися в програмі 'Листоноша' за допомогою наявного облікового запису електронної пошти. Вхід в обліковий запис зберігає всі колекції та запити Поштовика, які зберігаються під час сеансу, і гарантує, що запити все ще доступні для роботи, коли той самий користувач входить в систему наступного разу.

Будь ласка, зверніться до Примітка розділ, щоб отримати детальну інформацію про загальнодоступну підроблену кінцеву точку API.

Ми проілюструємо зразок запиту GET до цього URL що дасть 100 повідомлень у відповідь як корисне навантаження JSON.

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

# 1) Відкрийте програму Поштовик (якщо ви ще не ввійшли з наявним або новим обліковим записом, спочатку увійдіть із відповідними обліковими даними).

Нижче наведено зображення початкового екрану інтерфейсу поштаря:

# два) Створіть новий запит та заповніть деталі відповідно до кінцевої точки, яку ми будемо використовувати для тесту чи ілюстрації. Давайте протестуємо отримання запиту на кінцеву точку REST API http://dummy.restapiexample.com/api/v1/employees

# 3) Після заповнення властивостей запиту натисніть 'НАДІСЛАТИ', щоб виконати запит на сервері, що розміщує кінцеву точку.

# 4) Як тільки сервер відповість, ми зможемо перевірити різні дані навколо відповіді.

Давайте розглянемо кожен із них детально.

За замовчуванням, як тільки відповідь завершиться, буде вибрано та відображено вкладку 'Тело відповіді'. Інші параметри відповіді, такі як код стану відповіді, час, необхідний для завершення запиту, розмір корисного навантаження відображаються безпосередньо під заголовками запиту (як на малюнку нижче).

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

Наприклад, для часу запиту - він надалі розбиватиме його на окремі компоненти, такі як час підключення, час розетки, пошук DNS, рукостискання тощо.

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

Тепер давайте розглянемо інші вкладки відповідей, тобто файли cookie та заголовки. У веб-світі файли cookie мають велике значення з точки зору сприяння досвіду на стороні клієнта та великої кількості інформації, пов’язаної з сесіями, щоб отримати всю інформацію про файли cookie, які було повернуто із сервера. Ви можете перейти на вкладку cookie і побачити це.

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

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

Це допомагає запобігти створенню запитів кожного разу, коли вам потрібно отримати відповідь на той самий запит, а також допомагає уникнути буденних стандартних завдань. Якщо потрібно, ви можете звернутися до минулих запитів (і відповідей також) у майбутньому.

Примітка: Для ілюстрації зразків запитів та відповідей ми будемо використовувати загальнодоступні підроблені сервери API, які дозволять робити всі типи HTTP-запитів та повертати дійсну відповідь HTTP.

Щоб назвати декілька, ми будемо використовувати наведені нижче підроблені сайти кінцевих точок API як посилання:

1. Приклад API відпочинку
2. JSON Типовий заповнювач

Альтернативний короткий посібник із встановлення листоноші

POSTMAN - це відкритий інструмент, доступний кожному, хто користується Інтернетом. Ви можете виконати наведені нижче дії та отримати інструмент POSTMAN, встановлений у вашому локальному комп'ютері.

Крок 1: відчинено Google та знайдіть інструмент POSTMAN. Ви отримаєте нижченаведений результат пошуку. Потім ви можете натиснути на Завантажити програму листоноші, і ви будете перенаправлені на веб-сайт getpostman.

В іншому випадку ви можете безпосередньо перейти до цього URL отримати інструмент POSTMAN.

Крок 2: Виберіть версію POSTMAN залежно від вашої операційної системи. У нашому випадку ми будемо використовувати POSTMAN для ОС Windows. Більше того, ми використовуємо Window-64 bit, тому завантажимо та встановимо POSTMAN для 64 bit.

Крок 3: Після натискання кнопки 'Завантажити' файл postman.exe буде завантажено у ваш локал. Клацніть на цей файл. Це установка в один клік, як і будь-яка інша програма, яка дозволить вам встановити надбудову POSTMAN для вашого браузера.

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

Це воно!! Ми успішно встановили та запустили програму POSTMAN.

Будівельні блоки ПОСТМАН

POSTMAN має безліч будівельних блоків, але для нашої мети ми обговоримо три основні будівельні блоки, які є важливими для кожної операції POSTMAN.

Ці три основні будівельні блоки:

# 1) Запит

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

Натисніть на Нове -> Запит

# 2) Колекція

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

Натисніть на Нове -> Колекція.

# 3) Навколишнє середовище

Навколишнє середовище - це регіон, де відбуватимуться всі ваші дії над API. Це може бути TUP, QA, Dev, UAT або PROD. У кожному проекті вже будуть налаштовані регіони, і вам просто потрібно оголосити у ньому свої глобальні змінні, такі як URL-адреса, ідентифікатор і пароль маркера, контекстні ключі, ключі API, ключі документа тощо.

Натисніть на Нове -> Навколишнє середовище.

Збереження запиту в колекції

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

Крок 1: У верхньому правому куті ви побачите кнопку “+ Новий”. Натисніть на цю кнопку, і у вас буде список будівельних блоків, які були показані під час першого запуску програми.

Крок 2: Клацніть на Запит.

Крок 3: Введіть назву запиту, яке є обов’язковим для заповнення полем. Потім натисніть «+ Створити колекцію».

Крок 4: Після натискання кнопки «+ Створити колекцію» він запитає ім’я (скажімо, Збірка колекції). Введіть назву колекції та натисніть Enter.

Крок 5: Клацніть на “Зберегти в колекції зразків” кнопку.

Зразок запиту та відповіді

Цей конкретний розділ дасть вам глибоке розуміння того, як протестувати API у POSTMAN.

Як ви можете бачити на зображенні нижче, у нас є наш запит, який ми вже створили (Test for SoftwareTestingHelp). Більше того, ви можете побачити спадне меню (поруч із URL-адресою), яке містить дієслова або методи, що підтримуються ПОЧТОМ.

Вони називаються HTTP-дієсловами. Ми спробуємо щось оновити за допомогою методу PUT, а потім отримаємо те саме за допомогою методу GET. Я припускаю, що читачі знають про функціональність цих дієслів HTTP, які використовуються при тестуванні API.

Тепер у нас є URL-адреса та метод запиту. Все, що нам потрібно, це жатки та корисне навантаження або корпус. У деяких випадках нам потрібно генерувати маркери (виходячи з потреб API).

Ми оголосимо наші заголовки HTTP, тобто Content-Type та Accept. Прийняття не завжди є обов’язковим, оскільки воно визначає формат, у якому ми будемо отримувати свою відповідь. За замовчуванням відповідь завжди JSON.

Не потрібно викручувати значення цих заголовків, оскільки POSTMAN надасть вам поради під час введення текстових областей ключа та значення.

Потім ми перейдемо до наступного обов’язкового розділу, який є “Body”. Тут ми надамо корисне навантаження у формі JSON. Ми знаємо, як писати власний JSON, отже, спробуємо створити власний JSON.

Зразок запиту

URL: http://www.mocky.io/v2/5cd6c3f23000004b006061c5

Заголовки

Тип вмісту: application / JSON
Прийняти = application / JSON

Тіло

Тепер вдари

Отримавши повний запит, натисніть кнопку «Надіслати» і перегляньте код відповіді. Код 200 OK означає успішну роботу. На зображенні нижче ви бачите, що ми успішно вдарили URL-адресу.

Наступний крок

Тепер ми виконаємо ще одну операцію під назвою GET. Ми спробуємо отримати той самий запис, який ми щойно створили.

Для операції GET нам не потрібно тіло чи корисне навантаження. Оскільки ми вже маємо наш зразок запиту з використанням методу PUT, все, що нам потрібно, це змінити метод на GET.

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

Оновлення: Додаткова інформація

Що таке API?

API (Application Programming Interface) - це файл jar, який містить кілька методів та інтерфейсів для виконання певної дії.

Зверніться до наведеного нижче прикладу та знімка екрана:

1. Створіть метод сум, який додає дві змінні і повертає суму двох змінних.
2. Потім створіть клас калькулятора, який містить кілька інших методів, таких як додавання, віднімання, множення, ділення тощо. Також можуть бути деякі допоміжні класи. Тепер об’єднайте всі класи та інтерфейси та створіть файл jar з назвою Calculator.jar, а потім опублікуйте його. Використовуйте API калькулятора для доступу до методів, що знаходяться всередині.
3. Деякі API є відкритими (Selenium), які можна редагувати, а деякі - ліцензійними (UFT), які не можна редагувати.

Пропоноване читання => Найкращі засоби управління API

Як саме називаються ці методи?

Розробники виставлять інтерфейс, платформу для виклику API калькулятора, і ми створюємо об'єкт класу калькулятора і викликаємо метод sum або будь-який метод.

Припустимо, що цей файл calculator.jar створений якоюсь компанією, і вони використовують цю утиліту через інтерфейс інтерфейсу користувача, тоді ми перевіряємо цю програму-калькулятор за допомогою інтерфейсу та автоматизуємо її за допомогою QTP / Selenium, і це називається Front End Testing.

що таке ключ безпеки мережі на маршрутизаторі

Деякі програми не мають інтерфейсу, тому для доступу до цих методів ми створюємо об'єкт класу і передаємо аргументи для тестування, і це називається Фонове тестування . Надсилання запиту та отримання відповіді відбуватиметься до кінця JSON / XML-файли.

Зверніться до наведеної нижче схеми:

Клієнт ПОСТМАН

• POSTMAN - це REST-клієнт, який використовується для тестування серверного API.
• У POSTMAN ми передаємо виклик API і перевіряємо відповідь API, коди стану та корисне навантаження.
• Swagger - це ще один інструмент HTTP-клієнта, за допомогою якого ми створюємо документацію щодо API, і за допомогою swagger ми також можемо натиснути на API і отримати відповідь.
• Перейдіть за посиланням https://swagger.io/
• Ви можете використовувати Swagger або POSTMAN для тестування API, і це залежить від компаній, яким клієнтом користуватися.
• У POSTMAN в основному ми використовуємо дзвінки GET, POST, PUT та DELETE.

Як завантажити клієнта POSTMAN?

Відкрийте Google Chrome і завантажте програму POSTMAN, доступну в магазині програм Chrome.

Зателефонуйте REST API за допомогою клієнта POSTMAN

У POSTMAN ми отримали багато методів, але ми використовуємо лише GET, PUT, POST і DELETE

• Опублікувати - Цей дзвінок створює нову сутність.
• ОТРИМАТИ - Цей дзвінок надсилає запит і отримує відповідь.
• ВСТАНОВИТИ - Цей виклик створює нову сутність та оновлює існуючу сутність.
• ВИДАЛИТИ - Цей виклик видаляє існуючу сутність.

Доступ до API можна отримати за допомогою користувальницького інтерфейсу, такого як банківська платформа, або там, де користувальницький інтерфейс недоступний, як внутрішні системи, де ми використовуємо клієнт REST API, такий як POSTMAN.

Інші клієнти також доступні, такі як SOAP UI, який є REST та SOAP-клієнт, такі як просунуті REST-клієнти JMeter може викликати API безпосередньо з браузера. POSTMAN - найкращий інструмент для виконання операцій POST та GET.

Також прочитайте => Перелік поглиблених підручників із SoapUI

Надішліть запит і отримайте відповідь у клієнті POSTMAN:

Для тестування ми використовуємо наданий API тут .

Перевірте кожен виклик CRUD у клієнті POSTMAN, використовуючи API, наданий фіктивним сайтом.

Під час тестування API ми в основному перевіряємо наступні пункти:

• Коди стану відповіді, див сторінка wiki для деталей.
• Повідомлення відповіді та тіло відповіді JSON.
• Під час тестування API спочатку попросіть розробника вказати URL-адресу кінцевої точки. Дивіться цю URL-адресу кінцевої точки https://reqres.in/.

# 1) ОТРИМАТИ дзвінок

Відправляє запит і отримує відповідь.

Кроки для тестування REST API:

• Пройти https://reqres.in//api/users?page=2 (? є параметром запиту, який відфільтровує результат, наприклад, друкує всю інформацію користувача на сторінці 2, параметр запиту залежить від розробника, як він визначатиме) як URI в клієнті POSTMAN.
• Параметр запиту визначається (?), А параметр шляху - (/).
• Виберіть метод GET.

• Надайте заголовки (якщо потрібно), наприклад User-Agent: «Програмне забезпечення».

• Клацніть на кнопку НАДІСЛАТИ.
• Якщо API працює нормально, у відповідь ми отримуємо:
  • Статус 200 - добре, це означає, що відповідь отримано успішно.
  • Відповідь JSON Корисне навантаження.
  • Повідомлення рядка

• Інший Приклад GET METHOD, де ми шукали інформацію про конкретного користувача, тобто ідентифікатор користувача = 3. Введіть URI = https://reqres.in/api/users/3

• Якщо дані недоступні для нашого пошуку, ми отримуємо порожнє повідомлення JSON та повідомлення про стан 404.

# 2) POST дзвінок

Створіть нового користувача або сутність.

Кроки для виконання:

• Виберіть POST зі спадного меню та використовуйте цю URL-адресу служби “https://reqres.in/api/users/100”
  
• Перейдіть до Body -> виберіть RAW -> Коли ми передаємо JSON.
• Виберіть JSON зі спадного меню та вставте скрипт корисного навантаження.
• Передайте це корисне навантаження {“name”: “Morpheus”, “job”: ”leader”}

• JSON починається з фігурних дужок і зберігає дані у форматі ключа, значення.
• Передайте тип вмісту заголовка = application / json.
• Натисніть кнопку НАДІСЛАТИ.

• На успішний запит ми отримуємо відповідь нижче:
  • Статус 201 - Створено, відповідь отримано успішно.
  • Відповідне корисне навантаження
  • Заголовок

# 3) PUT дзвінок

Оновлює або створює нову сутність.

Кроки для створення виклику PUT:

• Використовуйте цю URL-адресу служби “https://reqres.in/api/users/206” та корисне навантаження {“name”: “Morpheus”, “job”: “Manager”
• Перейдіть до клієнта POSTMAN і виберіть метод PUT -> Перейдіть до основного тексту -> Виберіть RAW> передайте JSON і виберіть JSON зі спадного меню та вставте скрипт корисного навантаження.
• JSON починається з фігурних дужок і зберігає дані у форматі ключ-значення.
• Натисніть кнопку НАДІСЛАТИ, щоб отримати успішний запит, ви отримаєте відповідь нижче.
  • Статус 200 - Добре, відповідь отримано успішно.
  • Відповідне корисне навантаження
  • Заголовок
  • Робота оновлена ​​до 'менеджер'

# 4) Видалити дзвінок

• Видаліть користувача, використовуйте цю URL-адресу служби “/ api / users / 423” та цей корисний набір {“name”: “Naveen”, “job”: “QA”}.
• Перейдіть до POSTMAN і виберіть метод DELETE, корисне навантаження не потрібно.
• Видаляє ідентифікатор користувача = 423, якщо він доступний у системі.
  • Статус 204 - Без вмісту, відповідь отримано успішно.
  • Не отримано корисного навантаження, ідентифікатор користувача видалено.
  • Заголовок

Проблеми в тестуванні API

• Тестові кейси повинні бути розроблені таким чином, щоб вони охоплювали тестове покриття.
• Розробка тестових випадків проста, коли API несе менше параметрів, але складність зростає, коли кількість параметрів велика.
• Регулярно оновлюйте тестове покриття, змінюючи вимоги до бізнесу. Якщо додано новий параметр, збільште набір тестових джгутів
• Правильно виконувати послідовність викликів API.
• Дослідіть граничні умови та характеристики.

Висновок

У цьому посібнику ми обговорили важливі рекомендації щодо початку роботи з інструментом тестування API Postman. Ми навчилися встановлювати інструмент 'Пошта' як самостійний додаток і обговорили, як ми можемо створити простий запит і подивитися на отриману відповідь.

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

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

Мова йде про те, наскільки вам комфортно писати власний JSON, переходити до будь-якого конкретного поля в JSON за допомогою ключа документа або параметрів, розуміти масиви в JSON тощо.

Клієнтський інструмент POSTMAN використовується для виконання внутрішнього тестування та головним чином для виконання викликів GET, PUT, POST, DELETE.

З цього підручника ми дізналися, як вдаватися до дзвінків від клієнта POSTMAN та як перевіряти відповідь, яку ми отримуємо від сервера, а також висвітлювали проблеми тестування API.

Тестування API дуже важливо, щоб знайти лазівки в API, оскільки хакери використовуватимуть їх і спричинять фінансові втрати. Тестування API здається простим, але ми повинні бути дуже обережними і спробувати тестувати з усіма можливими комбінаціями.

У нашому майбутньому навчальному посібнику ми дізнаємось, як користуватися інструментом 'Листоноша' для форматів API Diff!

НАЗАД Підручник | НАСТУПНИЙ підручник

Рекомендована література

• Підручник з Parasoft SOAtest: інструмент тестування API без скриптів
• Підручник з тестування API: повний посібник для початківців
• Найкращі засоби тестування програмного забезпечення 2021 р. (Інструменти автоматизації тестування якості)
• Підручник з деструктивного контролю та неруйнівного контролю
• Функціональне тестування проти нефункціонального тестування
• Підручник із інструменту тестування доступності WAVE
• Підручник з тестування доступності (повний покроковий посібник)
• Підручник з тестування SOA: Методологія тестування для архітектурної моделі SOA