Insomnia — що це, REST і GraphQL клієнт у розробці

Що таке Insomnia та ключові особливості

Insomnia — крос-платформовий застосунок (Electron) для надсилання HTTP-запитів і налагодження API. Розробляється компанією Kong з 2016 року як альтернатива Postman з акцентом на швидкість роботи та конфіденційність: дані зберігаються локально, хмарна синхронізація опційна і потребує реєстрації.

Інтерфейс і навігація

Головне вікно розділене на три колонки: зліва — дерево запитів (Workspace), по центру — редактор запиту з вкладками Params, Headers, Body, справа — панель відповіді з режимами Pretty, Raw і Preview. Темна тема увімкнена за замовчуванням, підтримуються кастомні теми через CSS-змінні.

Генерація коду

Insomnia підтримує експорт запиту в код 20+ мовами та фреймворками: cURL, HTTPie, Python Requests, JavaScript Fetch/Axios, Kotlin OkHttp, Swift URLSession, Java Unirest, Ruby Net::HTTP та інші. Генератор враховує заголовки, тіло запиту та тип автентифікації, що прискорює інтеграцію API в код застосунку.

Insomnia vs Postman: порівняння API-клієнтів

Insomnia і Postman вирішують одне завдання, але з різними пріоритетами. Insomnia легший (~80 MB проти ~300 MB), швидше запускається і працює повністю офлайн без нав'язування реєстрації. Postman пропонує зрілішу екосистему з моніторингом, mock-серверами та командними workspace.

Вибір інструмента під завдання

Для індивідуальної розробки та швидкого тестування ендпоінтів Insomnia зручніший завдяки легкості та відсутності реєстрації. Для командної роботи зі спільною колекцією, CI/CD-інтеграцією та моніторингом production-API Postman залишається стандартом індустрії.

Організація робочого простору та оточення

Workspace в Insomnia містить дерево запитів, розділене на папки. Кожен запит може бути типу HTTP, GraphQL, WebSocket або gRPC. Підтримується перетягування, дублювання та групування запитів за кольоровими мітками. Файл конфігурації workspace зберігається у форматі JSON.

Змінні оточення з успадкуванням

Insomnia підтримує вкладені оточення (Sub Environments), які успадковують змінні батьківського. Це дозволяє визначити базовий URL у глобальному оточенні та перевизначати лише відмінні параметри для різних середовищ. Змінні підставляються через синтаксис {`{`}_variable${`}`}.

// Приклад структури оточення Insomnia
{
    "base_url": "https://api.example.com",
    "timeout": 5000,
    "headers": {
        "Content-Type": "application/json",
        "Accept": "application/json"
    }
}

Робота з GraphQL в Insomnia

Insomnia надає один із найкращих серед API-клієнтів редакторів GraphQL. Вкладка GraphQL Query дозволяє писати запити з автодоповненням полів на основі завантаженої схеми. Справа відображається документація за типами, полями та аргументами в реальному часі.

Завантаження схеми та Introspection

Схема завантажується через GraphQL Introspection запит до ендпоінта. Insomnia кешує схему локально та автоматично оновлює її при змінах. Після завантаження стають доступними автодоповнення (Ctrl+Space), валідація запиту та попередній перегляд можливих помилок до надсилання.

# GraphQL запит зі змінними в Insomnia
query GetUser($id: ID!) {
    user(id: $id) {
        name
        email
        posts {
            title
            createdAt
        }
    }
}

Плагіни та розширення можливостей

Insomnia Plugin Hub містить понад 100 плагінів, що розширюють функціональність клієнта. Плагіни встановлюються через меню Preferences → Plugins або вручну через npm. Популярні категорії включають генерацію тестових даних, експорт у різні формати та кастомні валідатори відповідей. Кожен плагін проходить обов'язкову модерацію перед публікацією в спільному хабі розробників.

Популярні плагіни

• insomnia-plugin-faker — генерація фейкових даних (ім'я, email, телефон) для тестових запитів.
• insomnia-plugin-aws4 — підпис запитів за AWS Signature Version 4 для роботи з Amazon API Gateway і S3.
• insomnia-plugin-utils — утиліти для роботи з датами, хешуванням і Base64 кодуванням прямо в запитах.

Плагіни пишуться на JavaScript і взаємодіють з Insomnia через API шаблонізатора (response.*, request.*, environment.*). Розробка плагіна потребує базового знання Node.js і публікації через npm-пакет з тегом insomnia-plugin.

CLI та автоматизація тестування

Inso CLI — консольна утиліта, вбудована в Insomnia, для запуску запитів і тестів з термінала. Inso запускає окремі запити або цілі колекції, експортує результати в JSON і може інтегруватися в CI/CD пайплайни. Команда inso run collection послідовно виконує всі запити в колекції.

Приклад інтеграції в GitHub Actions

Inso CLI працює в Docker-контейнерах і headless-режимі, що дозволяє використовувати його в GitHub Actions і GitLab CI. Конфігурація запуску описується в YAML-файлі із зазначенням шляху до експортованої колекції та оточення. Підтримуються асершени на статус-код і тіло відповіді через JavaScript-скрипти.

# GitHub Actions workflow з Inso CLI
- name: Run API tests
  run: npx insomnia-inso run collection
    --collection "Auth API"
    --env "Staging"
    --reporter junit
    --output reports/api-results.xml

Інтеграція Insomnia з Git та командна робота

Insomnia підтримує синхронізацію колекцій через Git. Файли колекцій зберігаються у форматі JSON і можуть бути додані в репозиторій проєкту. Insomnia надає вбудований Git-клієнт для перегляду змін, створення коммітів і вирішення конфліктів злиття прямо з інтерфейсу.

Налаштування Git-синхронізації

Для підключення Git створіть локальну папку з репозиторієм і вкажіть її як кореневу директорію в налаштуваннях Insomnia. Застосунок автоматично відстежує зміни у файлах колекції та відображає їх у панелі Version Control. Підтримуються стандартні операції: commit, push, pull і перегляд diff між версіями.

Командна робота через Insomnia Cloud

Для проєктів без Git Insomnia пропонує хмарну синхронізацію через Insomnia Cloud. Безкоштовний тариф включає до 3 учасників команди та автоматичне резервне копіювання колекцій. Платні тарифи додають керування доступом, аудит змін і пріоритетну підтримку.

Design Mode та генерація специфікацій

Design Mode в Insomnia дозволяє створювати API-специфікації у форматі OpenAPI 3.0. Режим працює як візуальний редактор: визначайте ендпоінти та схеми даних без написання YAML вручну. Специфікацію можна експортувати в JSON або YAML.

Генерація колекції з OpenAPI

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

Тегування запитів

Кожному запиту можна призначити кольорову мітку: red, blue, green, orange, purple. Фільтрація за тегами працює через пошуковий рядок незалежно від структури папок, що спрощує навігацію в проєктах із сотнями ендпоінтів і безліччю модулів.

Design Mode та генерація специфікацій

Design Mode в Insomnia дозволяє створювати API-специфікації у форматі OpenAPI 3.0 прямо всередині застосунку. Режим працює як візуальний редактор: визначайте ендпоінти, схеми даних і параметри без написання YAML вручну. Специфікацію можна експортувати в JSON або YAML для публікації в репозиторіях.

Генерація колекції з OpenAPI

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

Тегування та фільтрація запитів

Для організації великої кількості запитів Insomnia підтримує тегування — кожному запиту можна призначити кольорову мітку: red, blue, green, orange, purple. Фільтрація за тегами працює через пошуковий рядок незалежно від структури папок, що спрощує навігацію в проєктах із сотнями ендпоінтів і безліччю функціональних модулів API.