Посібник з тестування REST API: Зразки ручних тестових випадків

⚡ Розумний підсумок

Тестування REST API перевіряє RESTful веб-сервіси, надсилаючи HTTP-запити, такі як GET, POST, PUT та DELETE, а потім перевіряючи код стану, заголовки відповідей та корисне навантаження, що повертаються сервером.

  • 🔑 Основна ідея: Використовуйте сервісний рівень безпосередньо, без використання користувацького інтерфейсу.
  • 🔁 Покриття методу: Виконуйте операції GET, POST, PUT та DELETE для кожного відкритого ресурсу.
  • 🛠️ Налаштування клієнта: Встановіть Advanced Rest Client, перш ніж надсилати перший запит.
  • 📋 Запит на збірку: Надайте кінцеву точку URL, метод, заголовки, параметри та корисне навантаження JSON.
  • ✅ Перевірки відповідей: Перевірте, чи відповідають код відповіді, повідомлення відповіді та тіло відповіді очікуванням.
  • 🔐 Глибина безпеки: Відтворити виклики з відсутніми, простроченими та низькопривілейованими токенами, щоб примусово генерувати відповіді 401 та 403.
  • 🤖 Підтримка AI: Машинне навчання створює корисні навантаження для крайніх випадків, які ручні тестувальники зазвичай не помічають.

Що таке тестування REST API?

Тестування REST API — це метод веб-тестування з відкритим кодом, який використовується для тестування RESTful API для веб-застосунків. Метою тестування REST API є запис відповіді REST API шляхом надсилання різних HTTP/S-запитів, щоб перевірити, чи REST API працює належним чином. Тестування REST API виконується методами GET, POST, PUT та DELETE.

REST розшифровується як Representational State Transfer. Це архітектурний стиль і підхід до спілкування, який використовується при розробці Web-сервісиREST став логічним вибором для створення API, оскільки він дозволяє користувачам ефективно підключатися та взаємодіяти з хмарними сервісами.

API, або інтерфейс прикладного програмування, – це набір інструкцій програмування для доступу до веб-програми. Іншими словами, це набір команд, що використовуються однією програмою для безпосереднього зв'язку з іншою та використання функцій одна одної для отримання інформації.

Na przykład,,en Google Вебсайт може мати API для пошуку, перекладів та календарів. Загалом, API виглядають як у прикладі нижче, з назвою сервера, шляхами та параметрами.

http://<server name>/v1/export/Publisher/Standard_Publisher_Report?format=csv
№1 НАЙКРАЩИЙ ЗАГАЛЬНИЙ РЕЗУЛЬТАТTestsigma
9.8/ 10
★ ★ ★ ★ ★
Отримайте безкоштовну демо-версію
PractiTest
9.5/ 10
★ ★ ★ ★ ★
Visit PractiTest
Testiny
9.3/ 10
★ ★ ★ ★ ★
Visit Testiny
Best ForАвтоматизація тестуванняТестовий менеджментМалі та середні команди з контролю якості
Основна особливість✓Генеруйте автоматизовані тести за лічені секунди✓Централізоване управління тестуванням✓Ручні + автоматизовані тестові випадки
Інтеграції✓Jenkins, Slack, Джира✓Джира, Jenkins, Slack✓Джира, GitHub, GitLab
Безкоштовна пробнаБезкоштовна демонстрація14-денна безкоштовна пробна версіяБезкоштовна демонстрація
Отримайте безкоштовну демо-версіюVisit PractiTestVisit Testiny

Але навіщо взагалі витрачати зусилля на тестування цього рівня?

Чому важливе тестування REST API

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

Швидкість — друга причина. Запит виконується за мілісекунди та не потребує браузера, механізму рендерингу та локаторів крихких елементів. Тестер може протестувати десятки кінцевих точок за той час, який потрібен одному тесту інтерфейсу для завантаження сторінки, і той самий запит поводиться однаково, незалежно від того, чи є фронтенд веб-сайтом, мобільним додатком чи партнерською інтеграцією.

Стабільність – третя причина. Макети постійно змінюються, але опублікований REST-конtracОчікується, що t залишиться стабільним. Тести, написані відповідно до цьогоtract переживають редизайн, тому вони захищають ті частини продукту, над якими фактично працюють інші команди.

Типи методів API

В основному існує 4 види Тестування API методи: GET, POST, DELETE та PUT.

  • GET– Метод GET використовується для extracінформацію з заданого сервера за допомогою заданого URI. Під час використання GET-запиту слід лишеtracдані та не повинні мати жодного іншого впливу на дані.
  • POST– Запит POST використовується для створення нової сутності. Його також можна використовувати для надсилання даних на сервер, наприклад, інформації про клієнтів, завантаження файлів тощо за допомогою HTML-форм.
  • PUT– Створіть нову сутність або оновіть існуючу.
  • DELETE– Видаляє всі поточні представлення цільового ресурсу, задані URI.

Як перевірити REST API

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

  • Інструмент/фреймворк тестування для керування API
  • Запис власного коду для тестування прикладу REST API

Тестові випадки REST API можна протестувати за допомогою таких інструментів, як:

  • Advanced Rest Client
  • Postman-Відпочинок клієнта
  • Curl в Linux

Тут ми будемо використовувати Advanced Rest Client. Нижче наведено кроки для його отримання.

Як отримати розширений клієнт для відпочинку?

  • Перейдіть до Google ChromeВеб-магазин користувача
  • Знайдіть «Advanced Rest Client» або перейдіть безпосередньо тут і встановіть розширення
  • Виберіть піктограму «Advanced Rest Client» у розділі програми chrome – chrome://apps/

Список інтернет-магазину виглядає, як показано нижче.

Як встановити Advance Rest Client

Після завершення встановлення виконайте наведений нижче тест для перевірки RESTful API.

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

Тут ми використовуємо розширення REST-клієнта у браузері Chrome. Щоб краще зрозуміти його, ми використовуємо фіктивний API для тестування:

http://ip.jsontest.com/

Крок 1) Відкрийте розширений клієнт REST

Запустіть програму Advanced REST client (ARC) після її успішного встановлення.

Відкрийте клієнт Advanced REST

Крок 2) Введіть URL API для тестування

Введіть зразок REST API URL для тестування в URL текстове вікно.

URL API для тестування

Крок 3) Виберіть метод HTTP

Виберіть метод для типу методів HTTP у тестуванні API, щоб досягти, наприклад, POST

Метод HTTP

Крок 4) Надайте набір заголовків

Надайте набір заголовків у текстовому полі Заголовки. Натисніть «Вставити набір заголовків».

Набір заголовків

Крок 5) Підтвердьте налаштування заголовків

Далі натисніть на USE THIS SET.

Набір заголовків

Крок 6) Надайте необхідний вміст Body

  1. Тепер перейдіть на вкладку «Тіло».
  2. Встановіть необхідний тип вмісту Body та перегляд редактора, наприклад, тип вмісту Body: application/json
  3. Вигляд редактора: необроблений вхід.
  4. У розділі «Корисне навантаження» передайте тіло запиту демонстраційного API для тестування у вигляді пар ключ-значення, наприклад {“key1″:”value1″,”key2″:”value2”}. Якщо це POST API, тоді нам потрібно передати тіло запиту або параметри. Ми передамо їх під заданим корисним навантаженням.
{"property" : ["Sites"], "report_type" : ["ALL"]}

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

⚠️ Попередження: Тип вмісту application/json з недійсним корисним навантаженням JSON повертає 400 Неправильний запит.

Крок 7) Надішліть деталі, щоб розпочати тест

  1. Натисніть кнопку відправити.
  2. Ви можете натиснути кнопку ДЕТАЛІ, щоб побачити заголовки відповіді.

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

Ось деталі відповіді:

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

Відповідь все ще потрібно оцінювати на основі очікуваного результату.

Перевірка результатів

Головним чином, для тестування веб-API нам потрібно перевірити код відповіді, повідомлення відповіді та тіло відповіді.

Коди відповідей поділяються на п'ять сімейств:

Family Категорія Сенс
1xx Інформаційний Отримано, все ще обробляється
2xx Успіх Завершено; 200 ОК, 201 Створено
3xx Redirection Потрібні подальші дії
4xx Помилка клієнта Неправильне корисне навантаження, токен або ресурс
5xx Помилка сервера Дійсний запит, збій сервера

Нижче наведено коди відповідей, з якими можна зіткнутися.

Перевірка результатів

Один запит доводить, що кінцева точка працює. Набір доводить, що вона продовжує працювати.

Тестові випадки REST API, які ви повинні розглянути

Корисний набір REST API охоплює кілька категорій, замість повторення одного й того ж виклику happy-path з різними даними:

  • Щасливого шляху: Надішліть дійсний запит до кожної кінцевої точки та підтвердьте код стану, схему та значення кожного поля.
  • Негативні випадки: Надішліть невірно сформований JSON, непідтримуваний метод та відсутній ідентифікатор ресурсу, а потім очікуйте 400, 405 та 404, а не 500.
  • Граничні значення: Якщо поле приймає від 1 до 200 символів, перевірте 0, 1, 200 та 201. Правила перевірки розриваються на краях.
  • Спеціальні символи: Проштовхуйте літери з діакритичними знаками, емодзі, цитати та багатобайтовий текст у кожному полі, щоб виявити помилки кодування.
  • зtract перевірки: Порівняйте відповідь з опублікованою специфікацією OpenAPI або Swagger, щоб незадокументовані зміни були виявлені на ранній стадії.
  • Послідовність: Викликайте кінцеві точки в реалістичному порядку, наприклад, POST, потім GET, потім DELETE, оскільки стан переноситься між викликами.
  • Розсудливість продуктивності: Фіксуйте час відгуку під час кожного запуску та позначайте будь-яку кінцеву точку, яка виходить за межі порогового значення, узгодженого з командою.

Інструмент тестування REST API

Різні інструменти підходять для різних етапів тестування.

Інструмент тип Найкраще для
Advanced Rest Client Клієнт для робочого столу Швидкі ручні виклики
Postman Клієнт для робочого столу Колекції та робочі простори команди
JMeter Тестування навантаженням Час відгуку під навантаженням
SoapUI Функціональне тестування REST та SOAP разом
ВІДПОЧИВАЙТЕ Впевнені Java бібліотека Автоматизація стабільних справ
cURL Командний рядок Вставка викликів у звіти про помилки

Дивіться огляд Інструменти тестування API.

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

Аутентифікація та перевірки безпеки REST API

Публічні демонстраційні кінцеві точки відповідають будь-кому, але REST API для виробничого середовища стоїть за схемою автентифікації, і недолік авторизації набагато шкідливіший, ніж неправильне значення поля. Спочатку визначте механізм: статичний ключ API, облікові дані HTTP Basic, токен-носій OAuth 2.0 або підписаний веб-токен JSON.

Після успішного автентифікованого запиту, ретельно пройдіть шляхи невдачі:

  1. Без посвідчень: Видаліть заголовок авторизації. Очікуйте помилку 401 «Неавторизовано» та відсутність даних запису в тілі.
  2. Неправильно сформовані облікові дані: пошкоджено один символ токена. Очікуйте знову помилку 401 з повідомленням, яке не пояснює причину.
  3. Термін дії облікових даних закінчився: повторно використовувати токен після закінчення терміну його дії. Переконайтеся, що його відхилено, а не прийнято, що є поширеним дефектом перекосу годинника.
  4. Неправильний рівень привілеїв: автентифікуватися як користувач з низькими правами та викликати кінцеву точку лише для адміністратора. Очікуйте код 403 «Заборонено», а не 200.
  5. Запис іншого користувача: змінити ідентифікатор, щоб користувач А запитував дані користувача Б. Успіх у цьому випадку є серйозним дефектом контролю доступу.

Нарешті, переконайтеся, що кожен виклик передається через HTTPS, що невдалі відповіді не витікають дані зі стеку tracбанери версій або версій, а швидкі повторення викликають помилку 429 «Занадто багато запитів».

Тестування REST API також створює труднощі, яких немає під час тестування інтерфейсів.

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

Цікавими проблемами для тестувальників під час тестування REST API є:

  1. Щоб переконатися, що тестовий хардкор змінює параметри викликів API таким чином, щоб перевіряти функціональність, а також виявляти збої. Це включає дослідження граничних умов та призначення спільних параметрів.
  2. Створення цікавих комбінацій значень параметрів для викликів із двома або більше параметрами
  3. Визначення контенту, для якого мають здійснюватися виклики API. Це може включати встановлення умов зовнішнього середовища (периферійні пристрої, файли тощо), а також внутрішньо збережені дані, що впливають на API.
  4. Послідовність викликів API відповідно до порядку виконання функції
  5. Щоб API виробляв корисні результати послідовних викликів.

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

REST-тестування працює з легким JSON або XML поверх простих HTTP-дієсловів. SOAP-тестування перевіряє суворий XML-оболонку на відповідність WSDL-конфіденційності.tract, тому йому потрібен клієнт, який враховує схему, такий як SoapUI а не простий REST-клієнт.

Ні. Такі клієнти, як Advanced Rest Client та Postman дозволяють створювати запити через форму. Кодування стає необхідним лише тоді, коли ви автоматизуєте ті самі випадки за допомогою бібліотеки, такої як ВІДПОЧИВАЙТЕ Впевнені.

Більшість команд вважають менше 300 мілісекунд позитивним часом, а менше однієї секунди – прийнятним для одного зчитування. Будь-що, що перевищує кілька секунд, шкодить викликаючій програмі, тому записуйте час кожного запуску та генеруйте дефект при дрейфі.

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

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

Підсумуйте цей пост за допомогою: