Insomnia — wat is het, REST- en GraphQL-client in ontwikkeling

Wat is Insomnia en de belangrijkste kenmerken

Insomnia — platformonafhankelijke applicatie (Electron) voor het verzenden van HTTP-verzoeken en het debuggen van API's. Sinds 2016 ontwikkeld door het bedrijf Kong als alternatief voor Postman met de nadruk op snelheid en privacy: gegevens worden lokaal opgeslagen, cloud-synchronisatie is optioneel en vereist registratie.

Interface en navigatie

Het hoofdvenster is verdeeld in drie kolommen: links — de verzoekboom (Workspace), in het midden — de verzoekeditor met de tabbladen Params, Headers, Body, rechts — het antwoordpaneel met de modi Pretty, Raw en Preview. Het donkere thema is standaard ingeschakeld, aangepaste thema's worden ondersteund via CSS-variabelen.

Codegeneratie

Insomnia ondersteunt export van het verzoek naar code in meer dan 20 talen en frameworks: cURL, HTTPie, Python Requests, JavaScript Fetch/Axios, Kotlin OkHttp, Swift URLSession, Java Unirest, Ruby Net::HTTP en andere. De generator houdt rekening met headers, de verzoekbody en het type authenticatie, wat de integratie van de API in de applicatiecode versnelt.

Insomnia vs Postman: vergelijking van API-clients

Insomnia en Postman lossen dezelfde taak op, maar met verschillende prioriteiten. Insomnia is lichter (~80 MB tegenover ~300 MB), start sneller en werkt volledig offline zonder registratie op te dringen. Postman biedt een volwassener ecosysteem met monitoring, mock-servers en team-workspaces.

Het juiste hulpmiddel voor de taak kiezen

Voor individuele ontwikkeling en snel testen van endpoints is Insomnia handiger dankzij de lichtheid en het ontbreken van registratie. Voor teamwerk met een gedeelde collectie, CI/CD-integratie en monitoring van productie-API's blijft Postman de industriestandaard.

Organisatie van werkruimte en omgevingen

Workspace in Insomnia bevat de verzoekboom, verdeeld in mappen. Elk verzoek kan van het type HTTP, GraphQL, WebSocket of gRPC zijn. Slepen, dupliceren en groeperen van verzoeken op kleurmarkeringen worden ondersteund. Het configuratiebestand van de workspace wordt opgeslagen in JSON-formaat.

Omgevingsvariabelen met overerving

Insomnia ondersteunt geneste omgevingen (Sub Environments), die variabelen van de ouder erven. Dit maakt het mogelijk om de basis-URL in de globale omgeving te definiëren en alleen de verschillende parameters voor verschillende omgevingen te overschrijven. Variabelen worden ingevuld via de syntax {`{`}_variable${`}`}.

// Voorbeeld van de structuur van een Insomnia-omgeving
{
    "base_url": "https://api.example.com",
    "timeout": 5000,
    "headers": {
        "Content-Type": "application/json",
        "Accept": "application/json"
    }
}

Werken met GraphQL in Insomnia

Insomnia biedt een van de beste GraphQL-editors onder de API-clients. Het tabblad GraphQL Query maakt het mogelijk verzoeken te schrijven met automatische aanvulling van velden op basis van het geladen schema. Rechts wordt in realtime documentatie van typen, velden en argumenten weergegeven.

Schema laden en Introspection

Het schema wordt geladen via een GraphQL Introspection-verzoek naar het endpoint. Insomnia slaat het schema lokaal in de cache op en actualiseert het automatisch bij wijzigingen. Na het laden worden automatische aanvulling (Ctrl+Space), validatie van het verzoek en een voorbeeld van mogelijke fouten vóór verzending beschikbaar.

# GraphQL-verzoek met variabelen in Insomnia
query GetUser($id: ID!) {
    user(id: $id) {
        name
        email
        posts {
            title
            createdAt
        }
    }
}

Plugins en uitbreiding van mogelijkheden

Insomnia Plugin Hub bevat meer dan 100 plugins die de functionaliteit van de client uitbreiden. Plugins worden geïnstalleerd via het menu Preferences → Plugins of handmatig via npm. Populaire categorieën omvatten generatie van testgegevens, export naar verschillende formaten en aangepaste antwoordvalidators. Elke plugin doorloopt verplichte moderatie vóór publicatie in de gedeelde hub van ontwikkelaars.

Populaire plugins

• insomnia-plugin-faker — generatie van neppe gegevens (naam, e-mail, telefoon) voor testverzoeken.
• insomnia-plugin-aws4 — ondertekening van verzoeken volgens AWS Signature Version 4 voor werken met Amazon API Gateway en S3.
• insomnia-plugin-utils — hulpmiddelen voor werken met datums, hashing en Base64-codering rechtstreeks in verzoeken.

Plugins worden geschreven in JavaScript en communiceren met Insomnia via de template-API (response.*, request.*, environment.*). Het ontwikkelen van een plugin vereist basiskennis van Node.js en publicatie via een npm-pakket met de tag insomnia-plugin.

CLI en automatisering van testen

Inso CLI — consolehulpprogramma ingebouwd in Insomnia voor het uitvoeren van verzoeken en tests vanuit de terminal. Inso voert afzonderlijke verzoeken of volledige collecties uit, exporteert resultaten naar JSON en kan worden geïntegreerd in CI/CD-pipelines. Het commando inso run collection voert achtereenvolgens alle verzoeken in de collectie uit.

Voorbeeld van integratie in GitHub Actions

Inso CLI werkt in Docker-containers en headless-modus, waardoor het in GitHub Actions en GitLab CI kan worden gebruikt. De uitvoeringsconfiguratie wordt beschreven in een YAML-bestand met vermelding van het pad naar de geëxporteerde collectie en omgeving. Asserties op statuscode en antwoordbody worden ondersteund via JavaScript-scripts.

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

Integratie van Insomnia met Git en teamwerk

Insomnia ondersteunt synchronisatie van collecties via Git. Collectiebestanden worden opgeslagen in JSON-formaat en kunnen aan de projectrepository worden toegevoegd. Insomnia biedt een ingebouwde Git-client voor het bekijken van wijzigingen, het maken van commits en het oplossen van merge-conflicten rechtstreeks vanuit de interface.

Git-synchronisatie instellen

Maak voor het koppelen van Git een lokale map met repository en geef deze aan als hoofddirectory in de Instellingen van Insomnia. De applicatie volgt automatisch wijzigingen in de collectiebestanden en toont deze in het paneel Version Control. Standaardbewerkingen worden ondersteund: commit, push, pull en het bekijken van diff tussen versies.

Teamwerk via Insomnia Cloud

Voor projecten zonder Git biedt Insomnia cloud-synchronisatie via Insomnia Cloud. Het gratis abonnement omvat maximaal 3 teamleden en automatische back-up van collecties. Betaalde abonnementen voegen toegangsbeheer, wijzigingsaudit en prioritaire ondersteuning toe.

Design Mode en generatie van specificaties

Design Mode in Insomnia maakt het mogelijk API-specificaties te maken in OpenAPI 3.0-formaat. De modus werkt als een visuele editor: definieer endpoints en gegevensschema's zonder YAML handmatig te schrijven. De specificatie kan worden geëxporteerd naar JSON of YAML.

Generatie van collectie uit OpenAPI

Insomnia importeert OpenAPI-specificaties en maakt een collectie van verzoeken voor elk endpoint. Paden en schema's worden omgezet in kant-en-klare HTTP-verzoeken. De functie is nuttig bij integratie met microservices, waar de specificatie in een aparte repository van het team wordt opgeslagen.

Taggen van verzoeken

Aan elk verzoek kan een kleurmarkering worden toegewezen: red, blue, green, orange, purple. Filteren op tags werkt via de zoekbalk onafhankelijk van de mappenstructuur, wat de navigatie vereenvoudigt in projecten met honderden endpoints en veel modules.

Design Mode en generatie van specificaties

Design Mode in Insomnia maakt het mogelijk API-specificaties te maken in OpenAPI 3.0-formaat rechtstreeks binnen de applicatie. De modus werkt als een visuele editor: definieer endpoints, gegevensschema's en parameters zonder YAML handmatig te schrijven. De specificatie kan worden geëxporteerd naar JSON of YAML voor publicatie in de repository.

Generatie van collectie uit OpenAPI

Insomnia importeert bestaande OpenAPI-specificaties en maakt automatisch een collectie van verzoeken voor elk endpoint. Paden en schema's worden omgezet in kant-en-klare HTTP-verzoeken met correcte gegevenstypen. Deze functie is nuttig bij integratie met microservices, waar de specificatie wordt opgeslagen en onderhouden door een apart team van backend-ontwikkelaars.

Taggen en filteren van verzoeken

Voor het organiseren van een groot aantal verzoeken ondersteunt Insomnia tagging — aan elk verzoek kan een kleurmarkering worden toegewezen: red, blue, green, orange, purple. Filteren op tags werkt via de zoekbalk onafhankelijk van de mappenstructuur, wat de navigatie vereenvoudigt in projecten met honderden endpoints en veel functionele API-modules.