Цей всеосяжний посібник по EchoAPI поділений на такі розділи: Огляд EchoAPI, Введення в основні функції, Створення API-запитів, Налагодження та тестування, Співпраця в команді та керування API, Змінні середовища та автоматизоване тестування.
Що таке EchoAPI?
EchoAPI — це потужний інструмент, розроблений для сучасних розробників, спрямований на спрощення та прискорення процесу розробки та тестування API. Подібно до Postman, він покращує співпрацю в команді та управління документацією, надаючи повну офлайн-функціональність. EchoAPI підтримує проектування API, налагодження API, тестування продуктивності, автоматизоване тестування, мок-сервіси та генерацію документації для API великих обсягів, що полегшує керування задачами з налагодження та тестування інтерфейсів.
Крім цих функцій, EchoAPI містить численні легкі плагіни, які безперешкодно інтегруються з різними середовищами розробки, ще більше спрощуючи ваш робочий процес.
Встановлення EchoAPI
Перейдіть на офіційний сайт EchoAPI, щоб завантажити та встановити версію, що підходить для вашої операційної системи.
Огляд інтерфейсу EchoAPI
Інтерфейс EchoAPI в основному складається з таких зон:
- Бічна панель API: керуйте своїми API та тестами API.
- Конструктор запитів: створюйте та надсилайте API-запити.
- Вікно відповіді: відображає вміст відповіді API.
- Налаштування змінних середовища: керуйте змінними, що використовуються в запитах (наприклад, адреси API, токени тощо).
- Співпраця в команді: дозволяє вам і вашим колегам обмінюватися API, документацією та тестовими даними.
Введення в основні функції
Створення нового запиту
Натисніть кнопку "New Request" (Новий запит) зліва, виберіть HTTP-метод, який ви хочете використовувати (GET, POST, PUT, DELETE тощо), введіть URL API та заповніть заголовки запиту, тіло та параметри запиту за потребою. Натисніть кнопку "Send" (Надіслати), щоб надіслати запит за вказаним URL, і перегляньте результати відповіді нижче.
Налаштування заголовків і параметрів запиту
- Заголовки: налаштуйте заголовки, такі як Content-Type, Authorization тощо.
- Параметри: параметри запиту, застосовні для GET-запитів.
- Тіло: для POST, PUT тощо, можна вказати тіло запиту, підтримуються формати, такі як form-data, raw (JSON тощо), binary та інші.
Перегляд результатів відповіді
Після успішного надсилання запиту, ви можете побачити наступне у вікні відповіді:
- Код статусу (наприклад, 200, 400, 500): вказує на статус запиту.
- Час відповіді: тривалість відповіді.
- Тіло відповіді: вміст, що повернув сервер, який може бути у форматах JSON, HTML, XML тощо.
- Заголовки: інформація про заголовки відповіді.
Збереження запитів
Після завершення створення API-запиту, ви можете зберегти його у своєму проекті для подальшого використання. Ви можете дати запиту ім'я та класифікувати його в різні папки.
Налаштування змінних середовища
Створення змінних середовища
Щоб тестувати API в різних середовищах (наприклад, розробка, тестування, продакшн), ви можете використовувати змінні середовища:
- Натисніть кнопку “Environment Settings” (Налаштування середовища) зверху.
- Створіть різні середовища (наприклад, Development (Розробка), Production (Продакшн)).
- Налаштуйте різні змінні для кожного середовища, такі як
{{base_url}}, зі значеннями, що можуть відрізнятися в різних середовищах.
Використання змінних середовища в запитах
В URL, заголовках і тілі запиту API ви можете безпосередньо використовувати змінні, як-от:
{{base_url}}/api/v1/user
EchoAPI автоматично замінить значення змінних на значення поточного середовища.
Тестування API та функції налагодження
Мокінг
EchoAPI надає сервіс Mock, який імітує відповіді API, що корисно для розробки на фронтенді та бекенді або для тестування, коли API на бекенді ще не завершено.
Ви можете знайти функціональність мок-сервісу в своєму проекті, створити нові мок-дані, визначити шляхи API та очікувані відповіді, а також здійснювати запити через мок-URL.
Автоматизоване тестування
EchoAPI підтримує автоматизоване тестування. Ви можете писати скрипти для перевірок після отримання відповіді. У вкладці Test (Тест) ви можете написати JavaScript для перевірки повернутих результатів. Наприклад, щоб перевірити, чи є статусний код 200:
pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});
Заплановані завдання та безперервна інтеграція
EchoAPI дозволяє налаштовувати заплановані завдання для автоматичного запуску тестів API через певні проміжки часу. Ви можете інтегрувати інструменти CI/CD, такі як Jenkins, для автоматизованого звітування про тести та управління робочими процесами.
Співпраця в команді та управління документацією API
Спільний доступ до запитів
EchoAPI надає можливості для співпраці в проекті, дозволяючи вам ділитися запитами API з членами команди. Створіть новий проект на бічній панелі та запрошуйте членів команди, що дозволяє всім мати доступ до запитів API та тестових випадків.
Автоматичне створення документації API
EchoAPI автоматично генерує документацію для API, що описує URL запитів, методи, параметри та відповіді на основі створених запитів. Натисніть "Export Documentation" (Експортувати документацію), щоб експортувати її у форматах, таких як Markdown або HTML, для зручнішого обміну та перегляду.
Розширені функції: Запис та аналіз трафіку
EchoAPI пропонує функцію запису трафіку, яка захоплює запити та відповіді API для аналізу продуктивності та аудиту безпеки. Увімкніть функцію запису, і EchoAPI буде реєструвати всі запити API протягом певного часу, що допоможе виявити потенційні проблеми з продуктивністю або безпекою.
Практичні вправи
Вправа 1: Простий GET запит
Мета: Надіслати GET запит і перевірити статус код відповіді JSON.
Приклад API: https://jsonplaceholder.typicode.com/posts
Кроки:
1. Створіть новий запит, вибравши метод GET.
2. Введіть URL: https://jsonplaceholder.typicode.com/posts
3. Натисніть "Send" (Надіслати) і перевірте повернуті дані відповіді.
4. Напишіть перевірку, щоб впевнитися, що статус код — 200.
Вправа 2: Створення ресурсу за допомогою POST запиту
Мета: Надіслати POST запит для створення нового ресурсу.
Приклад API: https://jsonplaceholder.typicode.com/posts
Кроки:
1. Створіть новий запит, вибравши метод POST.
2. Встановіть заголовок: Content-Type: application/json.
3. У тілі запиту введіть наступне:
{
"title": "foo",
"body": "bar",
"userId": 1
}
- Надіслати запит і перевірити дані відповіді, щоб переконатися, що поле
idне порожнє.
Інтеграція з простим бекендом Spring Boot
Припустимо, у вас є простий бекенд Spring Boot, який працює локально на порту 8080, ось практичні тести:
Вправа 1: Простий GET запит
- Мета: Надіслати GET запит для отримання даних користувача і перевірити, що статус код відповіді — 200.
- Приклад API (Java Backend):
/api/v1/users
Кроки:
1. Запустіть ваш локальний Java проект на http://localhost:8080.
2. В EchoAPI натисніть “New Request” (Новий запит) і виберіть метод GET.
3. Введіть локальний URL API: http://localhost:8080/api/v1/users.
4. Натисніть "Send" (Надіслати) і перевірте очікувану JSON відповідь.
5. Напишіть перевірку у вкладці Test (Тест), щоб підтвердити статус код.
Вправа 2: Створення користувача за допомогою POST запиту
Мета: Надіслати POST запит для створення нового користувача і перевірити успішність операції.
Приклад API (Java Backend)
Припустимо, ми маємо інтерфейс для створення користувачів за адресою /api/v1/users, цей інтерфейс приймає POST запит для створення нового користувача і повертає дані користувача після успішного створення.
{
"id": 3,
"name": "foo",
"email": "[email protected]"
}
Практичні кроки:
- Створіть новий запит:
В EchoAPI натисніть “New HTTP” (Новий HTTP) і виберіть метод POST.
2.
Встановіть URL:
Введіть URL: http://localhost:8080/api/v1/users. - Встановіть заголовок запиту:
У розділі Headers (Заголовки) встановіть заголовок запиту Content-Type: application/json, оскільки ми будемо надсилати дані у форматі JSON. - Заповніть тіло запиту:
У розділі Body (Тіло) виберіть режим raw (сирий) та виберіть формат JSON. У тілі запиту введіть наступні дані, щоб імітувати створення нового користувача:
- Надіслати запит:
- Натисніть кнопку Send (Надіслати) і перевірте дані відповіді. Очікувана відповідь повинна повернути новий об'єкт користувача, що містить поле id, як показано нижче:
- Напишіть перевірку:
У вкладці Test (Тест) напишіть тестовий скрипт для перевірки наявності поля id. Наприклад:
pm.test("ID exists in response", function () {
var jsonData = pm.response.json();
pm.expect(jsonData).to.have.property("id");
});
Приклад коду Spring Boot
Ось приклад реалізації API в додатку на Java Spring Boot:
GET /api/v1/users (Отримання списку користувачів):
@RestController
@RequestMapping("/api/v1/users")
public class UserController {
private List users = Arrays.asList(
new User(1, "John Doe", "[email protected]"),
new User(2, "Jane Doe", "[email protected]")
); @GetMapping
public List getAllUsers() {
return users;
}
}
POST /api/v1/users (Створення нового користувача):
@RestController
@RequestMapping("/api/v1/users")
public class UserController {
private List users = new ArrayList<>(Arrays.asList(
new User(1, "John Doe", "[email protected]"),
new User(2, "Jane Doe", "[email protected]")
)); @PostMapping
public User createUser(@RequestBody User user) {
user.setId(users.size() + 1); // Автоматичне генерування ID
users.add(user);
return user;
}
}
Опис класу User (Користувач):
public class User {
private int id;
private String name;
private String email;
// Конструктор, геттери та сеттери пропущені для стислості
}
Дотримуючись цього посібника, ви зможете ефективно використовувати EchoAPI для тестування та управління вашими проектами на Java backend (бекенд) ефективно. Успішних тестувань!
Спробуйте EchoAPI для IntelliJ IDEA вже сьогодні!
https://www.echoapi.com/plugin/idea?utm_source=6715d073
Перекладено з: Mastering EchoAPI: A Comprehensive Guide to API Development, Testing, and Collaboration