Utiliser Apidog dans VS Code : Guide Complet

En bref

L'extension Apidog pour VS Code vous permet d'envoyer des requêtes API, de gérer des collections, d'exécuter des tests et de partager des espaces de travail avec votre équipe – le tout sans quitter votre éditeur. La configuration prend moins de cinq minutes : installez l'extension, connectez-vous à votre compte Apidog gratuit, et votre espace de travail se charge directement dans la barre latérale de VS Code.

Essayez Apidog dès aujourd'hui

💡Apidog est une plateforme de développement API tout-en-un et gratuite. L'extension VS Code connecte votre éditeur directement à votre espace de travail Apidog afin que vous puissiez tester des API, rédiger des documentations et collaborer avec votre équipe sans changer de fenêtre. Essayez Apidog gratuitement, aucune carte de crédit requise.

Introduction

Apidog a débuté comme une application de bureau pour la conception, le test et la documentation d'API. L’extension VS Code intègre maintenant le même espace de travail directement dans votre éditeur, en gardant vos collections, environnements et cas de test synchronisés entre VS Code, l’application de bureau et l’interface web.

Ce guide propose un workflow complet et pratique : installation de l’extension, connexion, envoi de requêtes, exécution de tests et utilisation conjointe avec l’application de bureau.

Étape 1 : Installer l’extension Apidog pour VS Code

Ouvrez VS Code.
Cliquez sur l’icône Extensions dans la barre latérale gauche ou appuyez sur Ctrl+Maj+X (Cmd+Maj+X sur Mac).
Cherchez « Apidog » dans la barre de recherche du Marketplace.
Sélectionnez l’extension publiée par Apidog Inc. (logo sombre avec lettres API stylisées).
Cliquez sur Installer.
Une fois l’installation terminée, l’icône Apidog s’ajoute à votre barre d’activité.
Cliquez sur cette icône pour ouvrir le panneau Apidog dans la barre latérale.

Étape 2 : Connectez-vous à votre compte Apidog

Dans le panneau Apidog, cliquez sur le bouton Se connecter.
Un onglet navigateur s’ouvre vers la page d’authentification Apidog.
Connectez-vous avec votre compte existant ou inscrivez-vous (adresse e-mail uniquement, aucun paiement requis).
Après connexion, retournez sur VS Code ou cliquez sur « Ouvrir VS Code » dans le navigateur.
Votre espace de travail Apidog se charge dans la barre latérale.

Aperçu de la barre latérale après connexion :

Vue arborescente du workspace.
Nom de l’espace de travail en haut, collections en dossiers, requêtes organisées.
Sélecteur d’environnement en haut du panneau.

Étape 3 : Naviguer dans vos collections

La barre latérale Apidog reflète la structure exacte de vos collections Apidog.
Dépliez une collection en cliquant sur la flèche à côté de son nom pour explorer les dossiers et requêtes.
Chaque requête affiche un badge de méthode HTTP (GET, POST, etc.) et s’ouvre dans un onglet de l’éditeur en cliquant dessus.

Recherche rapide :

Utilisez le champ de recherche en haut du panneau pour filtrer par nom, URL, ou méthode.

Changer d’espace de travail :

Utilisez le sélecteur en haut du panneau si votre compte a plusieurs workspaces.

Étape 4 : Envoyer des requêtes

Ouvrez une requête depuis la barre latérale (s’ouvre dans l’éditeur central).
Configurez la requête :
- Barre supérieure : sélectionnez la méthode, saisissez l’URL, cliquez sur Envoyer.
- Onglets : Paramètres, En-têtes, Corps, Authentification, Scripts de pré-requête, Tests, Paramètres.
Ajoutez les en-têtes nécessaires dans l’onglet En-têtes.
Pour POST/PUT, ajoutez le payload dans Corps (JSON, form-data, etc.).
Cliquez sur Envoyer.

Résultat :

La réponse s’affiche dans la moitié inférieure : code d’état, temps de réponse, taille, corps (coloration JSON/XML), en-têtes, cookies, tests.

Utiliser des environnements :

Le sélecteur d’environnement applique les variables ({{base_url}}, {{token}}, etc.) à la volée. Changez d’environnement pour cibler dev/staging/prod.

Étape 5 : Modifier et créer des requêtes

Modifier une requête :

Ouvrez une requête, modifiez-la, les changements sont synchronisés automatiquement.

Créer une nouvelle requête :

Clic droit sur une collection/dossier dans la barre latérale.
Sélectionnez Nouvelle requête.
Renseignez la méthode, l’URL, en-têtes, corps.
Enregistrez avec Ctrl+S / Cmd+S.

La requête apparaît instantanément pour tous les membres du workspace.

Renommer et organiser :

Clic droit pour renommer, déplacer, dupliquer, ou supprimer.
Glisser-déposer supporté pour réorganiser l’arborescence.

Étape 6 : Exécuter des tests

Dans l’onglet Tests d’une requête, écrivez des assertions JavaScript :

pm.test("Status is 200", function () {
  pm.response.to.have.status(200);
});

pm.test("Response contains user id", function () {
  const json = pm.response.json();
  pm.expect(json.id).to.be.a('number');
});

Après l’envoi, l’onglet Tests affiche les succès/échecs et les messages d’erreur.

Exécuter une collection complète :

Clic droit sur une collection/dossier > Exécuter la collection
Définissez itérations, délais, environnement
Cliquez sur Exécuter pour lancer toutes les requêtes séquentiellement. Les résultats détaillent les assertions réussies/échouées.

Étape 7 : Utiliser l’extension VS Code et l’application de bureau ensemble

L’extension VS Code et l’application de bureau partagent le même workspace, synchronisé en temps réel.

Exemples de workflow :

Conception dans l’app de bureau, tests dans VS Code : Modélisez l’API, rédigez la doc, configurez les mock servers côté bureau, puis testez et écrivez les assertions directement dans VS Code.
Revue d’API en équipe : Les modifications faites côté backend dans l’application de bureau sont instantanément visibles dans VS Code via l’extension.
Tests en contexte : Développez et testez vos endpoints dans VS Code sans changer d’application.
Quand privilégier l’application de bureau : Pour la conception de schémas, la gestion avancée des environnements, la configuration de mock servers et la publication de documentation.

Étape 8 : Partager avec votre équipe

Depuis l’interface web ou l’app de bureau Apidog, ouvrez les paramètres du workspace.
Invitez vos coéquipiers par e-mail.
Une fois invités et l’extension installée, ils accèdent immédiatement à toutes les collections et modifications en temps réel dans VS Code.

Le plan gratuit prend en charge jusqu’à trois utilisateurs. Synchronisation via le cloud : pas de git, pas d’export/import de fichiers, pas de conflits de merge.

FAQ

L’extension Apidog pour VS Code fonctionne-t-elle sans l’application de bureau ?

Oui. L’extension est un client complet pour votre workspace Apidog, sans dépendance à l’application de bureau.

Puis-je utiliser l’extension hors ligne ?

Vous pouvez consulter et éditer les collections en cache. L’envoi de requêtes externes nécessite Internet. La synchronisation dépend de l’état du cache local.

Importer des collections Thunder Client ou Postman ?

Depuis l’application de bureau ou le web, utilisez la fonction Importer (formats : JSON Thunder Client, Postman v2.1, OpenAPI…). Les collections importées sont accessibles instantanément dans VS Code.

Créer un nouveau projet depuis VS Code ?

Non. Créez et gérez les workspaces dans l’application de bureau ou le web. L’extension VS Code agit comme un client connecté à ces espaces de travail.

Édition simultanée d’une collection ?

Oui. L’édition n’est pas verrouillée. La dernière sauvegarde prévaut en cas de modification concurrente. Pour la coédition avancée, utilisez l’application de bureau.

Auto-complétion des variables d’environnement ?

Oui. En tapant {{ dans un champ, l’extension suggère les variables disponibles selon l’environnement actif.

L’extension Apidog pour VS Code est idéale comme outil quotidien pour gérer et tester vos APIs sans quitter votre environnement de développement. Sa configuration rapide vous permet d’accéder à toutes vos collections, environnements et espaces d’équipe sans changer de fenêtre.

Découvrir Apidog