[Guide] Contrôle de version de vos API avec Postman

Le maintien de révisions d'API cohérentes et bien documentées est crucial pour un développement d'API efficace. Cependant, la gestion de nombreuses versions et la collaboration efficace sur les modifications au sein d'une équipe peuvent être une entreprise complexe.

💡

Apidog est une solution tout-en-un pour tous les problèmes liés aux API. De la même manière que Postman, vous pouvez utiliser la fonctionnalité Historique d'Apidog pour afficher toutes les modifications passées, ce qui vous permet d'observer ou de restaurer toute modification effectuée dans le passé.

Pour en savoir plus sur les capacités d'Apidog, cliquez sur le bouton ci-dessous ! 👇

button

Ce guide explore les fonctionnalités du système de contrôle de version intégré de Postman, vous permettant de gérer efficacement les versions d'API, de rationaliser la collaboration et de maintenir une piste d'audit claire des modifications. En tirant parti de ces fonctionnalités, vous pouvez garantir un flux de travail de développement d'API plus organisé et efficace.

Qu'est-ce que Postman ?

Postman agit comme un hub central pour le développement d'API, rationalisant le processus pour les programmeurs. Sa suite complète de fonctionnalités englobe la conception, les tests et les capacités de documentation. Cette consolidation des fonctionnalités a consolidé la position de Postman en tant qu'outil privilégié pour les développeurs s'attaquant à un large éventail de projets liés aux API.

Qu'est-ce que le contrôle de version de Postman ?

Le contrôle de version de Postman vous permet, ainsi qu'à une équipe, de créer et de modifier une API en collaboration. Le contrôle de version est spécialisé dans la gestion de :

Collections d'API : Les collections définissent vos requêtes d'API, qui incluent les URL, les paramètres, les en-têtes et le contenu du corps.

Environnements d'API : Les variables d'environnement d'API sont stockées dans le contrôle de version de Postman pour être utilisées dans vos collections. Cela permet aux utilisateurs de basculer facilement entre les environnements de développement, de test et de production.

Simulations d'API : Les simulations d'API simulent la réponse du serveur pour les points de terminaison d'API, ce qui les rend utiles à des fins de test.

Fonctionnalités de contrôle de version de Postman

Le contrôle de version de Postman offre une variété de fonctionnalités permettant aux développeurs de maximiser les processus de développement d'API. tels que :

Suivi des modifications

Conservez un historique clair des modifications de vos collections, environnements et simulations.
Identifiez qui a effectué des modifications spécifiques et identifiez l'horodatage exact pour une meilleure responsabilité et collaboration.

Forking et fusion

Inspiré des flux de travail Git, Postman vous permet de créer une copie (fork) d'un élément (collection, environnement, simulation) pour un travail indépendant.
Une fois les modifications terminées, fusionnez facilement vos modifications dans la version principale, rationalisant la collaboration et intégrant les contributions individuelles.

Demandes d'extraction

Favorisez un développement transparent en permettant aux membres de l'équipe de revoir les modifications proposées avant de les fusionner dans la version principale.
Ce processus collaboratif permet d'identifier et de résoudre les conflits potentiels avant qu'ils ne perturbent le flux de travail.

Historique des versions

Accédez aux itérations passées de vos collections, environnements et simulations.
Cet enregistrement historique vous permet de revenir aux versions antérieures si nécessaire, offrant une sécurité en cas de modifications involontaires.

Intégration avec des systèmes de contrôle de version externes

Bien que le système intégré de Postman excelle dans la gestion des artefacts d'API, il peut également s'intégrer à des systèmes externes comme Git.
Cette synchronisation vous permet de gérer les modifications de vos collections Postman aux côtés de votre base de code dans un référentiel unique, favorisant une source de vérité unifiée pour vos définitions d'API.

Démonstration d'exemple du contrôle de version de l'API Postman

Cette démonstration d'exemple du contrôle de version de l'API sur Postman inclura l'utilisation d'un référentiel Git.

Créer une API dans Postman

Créez une nouvelle requête en cliquant sur le bouton New dans le coin supérieur gauche de la fenêtre Postman. Sélectionnez HTTP Request pour créer une nouvelle requête, comme indiqué dans l'image ci-dessus.

Saisir la méthode et les détails de l'API

Incluez les détails de la requête d'API que vous souhaitez créer. Elle doit inclure des composants tels que l'URL, les méthodes HTTP et les paramètres supplémentaires requis par l'API.

Sélectionner les paramètres de l'équipe

Continuez en cliquant sur Team Settings.

Sélectionner les applications installées

Vous serez redirigé vers une page Web pour une configuration ultérieure. Sur cette page, recherchez Installed apps dans la liste verticale de gauche. Si vous avez soit GitHub Enterprise Server ou GitLab Self-Managed, alors ces applications apparaîtront sur cet écran.

Saisir l'URL du domaine du référentiel GitHub

Saisissez l'URL du domaine de votre référentiel GitHub, qui devrait ressembler à ceci :

GitHub Enterprise Server : https://my-github-server.example.com

GitLab Self-Managed : https://gitlab.example.com

Créer une application OAuth

En suivant le fournisseur Git que vous avez, respectez les instructions pour créer une application OAuth.

URL de la page d'accueil - Saisissez l'URL de la page d'accueil de Postman : https://www.postman.com
URL de rappel d'autorisation ou URI de redirection - Saisissez l'URL de rappel d'autorisation fournie dans Postman : https://integration-oauth.pstmn.io/v1/api-git-callback.html
Scopes - Assurez-vous de sélectionner les scopes appropriés lors de la création de l'application OAuth pour permettre à Postman de lire et d'écrire dans votre référentiel. Pour GitHub, sélectionnez les scopes repo et user. Pour GitLab Self-Managed, sélectionnez le scope api.

Une fois que vous avez l'application OAuth, copiez son ID client et son secret pour les saisir dans Postman.

Collaboration simple et directe avec Apidog

Apidog est une puissante plateforme de développement d'API qui peut être un excellent remplacement pour Postman. Grâce à une collaboration fiable et à un système de contrôle de version distinctif natif d'Apidog, les utilisateurs peuvent travailler ensemble en équipe pour développer des API de manière professionnelle et efficace.

button

Création d'API avec Apidog

Avec Apidog, vous et votre équipe pouvez créer des API en quelques clics.

Pour commencer, appuyez sur le bouton New API, comme indiqué dans l'image ci-dessus.

Procédez en définissant les différentes caractéristiques de l'API. Cette section vous permet de :

Spécifier la méthode HTTP : Sélectionnez la méthode HTTP appropriée (GET, POST, PUT ou DELETE) pour dicter l'opération du serveur souhaitée.
Définir l'URL du point de terminaison de l'API : Indiquez l'URL spécifique du point de terminaison de l'API (ou l'adresse de l'API) qui facilite l'interaction client-serveur.
Incorporer des paramètres (facultatif) : Incluez un ou plusieurs paramètres à inclure dynamiquement dans l'URL de l'API, ce qui permet des requêtes personnalisées.
Fournir une description fonctionnelle : Rédigez une description concise qui élucide la fonctionnalité prévue de l'API.

Contrôle de version avec Apidog

Dans la section Conception de votre API, cliquez sur la petite icône carrée comme indiqué dans l'image ci-dessus. Cela vous mènera à la section du journal des modifications de votre API.

Dans cette liste, vous pouvez sélectionner la mise à jour que vous souhaitez afficher.

Enfin, vous pouvez observer les modifications apportées d'une version de votre API à une autre. Vous pouvez voir quand la modification a été effectuée et par qui la modification a été effectuée. Si, dans tous les cas, une ancienne version de l'API est requise, les utilisateurs auront également la possibilité de la restaurer vers une ancienne version sélectionnée.

button

Conclusion

Tirer parti efficacement des fonctionnalités de contrôle de version de Postman permet aux développeurs de cultiver un environnement de développement d'API plus organisé et collaboratif. Ce guide vous a fourni les connaissances nécessaires pour suivre les modifications, faciliter la collaboration d'équipe grâce à des fonctionnalités telles que le forking et la fusion, et maintenir un historique clair des révisions d'API.

N'oubliez pas qu'une stratégie de contrôle de version bien définie est essentielle pour rationaliser votre flux de travail, prévenir les conflits et assurer l'évolution en douceur de vos API. Adoptez les fonctionnalités intégrées de Postman et explorez l'intégration potentielle avec des systèmes externes pour établir une approche de contrôle de version qui renforce votre équipe de développement.