Qu'est-ce qu'Insomnia vous permet de faire ?
Insomnia est une application de bureau open-source conçue pour simplifier la conception, le débogage et le test d'APIs (interfaces de programmation d'applications) REST, GraphQL, WebSocket et gRPC. Elle offre une interface conviviale combinée à des fonctionnalités avancées, telles que des assistants d'authentification, la génération de code et la gestion des variables d'environnement, rendant le développement et les tests d'API plus efficaces.
Comment le télécharger ?
Rendez-vous sur la page dédiée à Insomnia sur la logithèqueComment l'installer et l'utiliser ?
Voici le guide :
Installation
Insomnia est disponible pour Windows, macOS et Ubuntu. Pour l'installer sur Windows, vous devez disposer de Windows 10 ou d'une version ultérieure. Le processus d'installation est simple.
Pour Windows :
- Téléchargez le programme d'installation
- Installation classique : Exécutez le fichier d'installation téléchargé et suivez les instructions de l'assistant d'installation.
- Installation silencieuse : Exécutez l'application depuis la ligne de commande avec l'argument
/Spour une installation sans interaction utilisateur. Vous pouvez également spécifier un répertoire d'installation personnalisé avec l'argument/D=chemin_dossier. Pour une installation à l'échelle du système, exécutez l'installateur avec des privilèges d'administrateur.
- Avant d'installer, fermez toute instance d'Insomnia en cours d'exécution, car l'installateur ne peut pas mettre à jour les fichiers en cours d'utilisation.
- Une fois l'installation terminée, lancez Insomnia.
Mises à jour automatiques :
Sur macOS et Windows, Insomnia peut se mettre à jour automatiquement. Pour activer cette fonctionnalité, allez dans Préférences > Général > Mises à jour logicielles > Télécharger et installer automatiquement les mises à jour et cochez la case. Sur Linux, le comportement de mise à jour dépend de la méthode d'installation.
Utilisation de l'interface utilisateur et des fonctionnalités principales
Une fois Insomnia lancé, vous serez accueilli par une interface claire. Si vous n'avez pas encore de projet, vous pouvez commencer par créer une nouvelle requête.
Création de requêtes
- Nouveau Document/Requête : Cliquez sur l'icône "+" à côté de "Documents" ou sur "Nouvelle requête" dans le menu pour commencer. Vous pouvez choisir entre un mode "Débogage" (pour tester directement sans spécifier de contrat d'API) ou un mode de conception d'API.
- Sélectionnez le Type de Requête : Dans la barre supérieure, choisissez le type de méthode HTTP (GET, POST, PUT, DELETE, etc.).
- URL : Entrez l'URL de l'API que vous souhaitez interroger.
- Corps de la Requête (pour POST, PUT, etc.) : Si votre requête nécessite un corps (par exemple, pour envoyer des données JSON), allez dans l'onglet "Corps" et sélectionnez le type de contenu approprié (par exemple, "JSON") puis rédigez votre contenu.
- En-têtes (Headers) : Pour ajouter des en-têtes personnalisés (comme les jetons d'authentification), allez dans l'onglet "En-têtes" et ajoutez votre clé et votre valeur.
- Authentification : Dans l'onglet "Auth", sélectionnez le type d'authentification approprié (Basic Auth, Bearer Token, OAuth 2.0, etc.) et renseignez les informations d'identification nécessaires.
- Envoyer la Requête : Cliquez sur le bouton "Envoyer". La réponse de l'API s'affichera dans le panneau de droite.
Organisation des requêtes avec les Collections
Insomnia vous permet de regrouper vos requêtes en collections pour une meilleure organisation.
- Créer une Collection : Cliquez sur "Créer une collection" et donnez-lui un nom pertinent (par exemple, le nom de votre projet).
- Ajouter des Requêtes : Vous pouvez ensuite ajouter de nouvelles requêtes à cette collection.
- Organiser : Créez des dossiers au sein de vos collections pour regrouper davantage les requêtes liées.
Gestion des Environnements et Variables
Les environnements vous permettent de gérer différentes configurations (par exemple, pour le développement, le staging, la production) et d'utiliser des variables réutilisables.
- Gérer les Environnements : Cliquez sur l'icône d'engrenage à côté de "Environnement de base" (ou similaire) dans la barre latérale.
- Créer un Environnement : Créez un nouvel environnement (par exemple, "Développement") ou modifiez-en un existant.
- Définir des Variables : Ajoutez vos variables sous forme de paires clé-valeur (par exemple,
baseUrl: http://localhost:3000). Vous pouvez également définir des variables dans l'environnement de base pour un partage global. - Utiliser les Variables : Dans vos requêtes, utilisez les variables en les entourant de doubles accolades, par exemple
{{baseUrl}}/users. Insomnia remplacera automatiquement{{baseUrl}}par la valeur définie dans votre environnement actif. Les environnements privés permettent de stocker la configuration localement, indépendamment du stockage principal du projet.
Tests Automatisés
Insomnia propose un framework de test intégré pour vérifier les réponses des APIs.
- Onglet Tests : Pour une requête donnée, cliquez sur l'onglet "Tests".
- Écrire des Scripts : Écrivez vos scripts de test en JavaScript en utilisant la bibliothèque d'assertions intégrée. Utilisez la fonction
expect()pour faire des assertions sur la réponse. Par exemple, vous pouvez tester le code de statut de la réponse, le contenu du corps, ou des valeurs spécifiques. - Exécuter les Tests : Lorsque vous envoyez la requête, les tests associés sont exécutés automatiquement.
Chaînage de Requêtes
Le chaînage de requêtes vous permet d'utiliser les données d'une réponse dans des requêtes ultérieures, ce qui est utile pour les flux d'authentification ou les dépendances entre les appels API.
- Exemple d'Authentification : Créez une première requête pour obtenir un jeton d'authentification.
- Extraction de Données : Dans l'onglet "Tests" de la requête d'authentification, extrayez le jeton de la réponse et stockez-le dans une variable d'environnement (par exemple,
accessToken). - Utilisation dans une Requête Subséquente : Dans une autre requête qui nécessite ce jeton, utilisez la variable d'environnement
{{accessToken}}dans l'en-tête "Authorization" (par exemple,Bearer {{accessToken}}). Insomnia peut être configuré pour renvoyer automatiquement la requête d'authentification si le jeton expire.
Génération de Code
Insomnia peut générer des extraits de code pour diverses tâches de programmation basées sur vos requêtes.
- Générer le Code : Après avoir reçu une réponse, cliquez sur le bouton "Générer le code" (icône ) dans le panneau de réponse.
- Sélectionner le Langage : Choisissez le langage ou le framework souhaité (par exemple, JavaScript, Python, cURL) pour obtenir le code correspondant à votre requête.
Télécharger Insomnia gratuitement