Appels API Postman

Introduction

Cet article approfondira les fondamentaux des services web, vous fournissant les connaissances et les exemples pratiques nécessaires pour devenir compétent dans la réalisation d’appels API avec Postman.

Les services web ont été un composant crucial des applications modernes depuis plus de deux décennies, évoluant considérablement depuis les années 2000. Ces services reposent fortement sur les API (Interfaces de Programmation d’Applications) pour communiquer et échanger des données. En tant que développeurs et testeurs, nous avons besoin d’outils robustes pour interagir efficacement avec ces API. C’est ici que Postman intervient.

L’interface utilisateur web de DataSunrise est basée sur des appels API utilisant des requêtes POST basées sur RPC et JSON. Même lorsqu’une commande est exécutée dans l’Interface en Ligne de Commande (CLI), le JSON requis est créé en fonction des options de la commande, puis transmis au backend pour appeler le RPC requis. Ce processus est également utilisé dans la console web pour créer et gérer des règles et autres configurations.

Qu’est-ce que Postman ?

Postman est un outil populaire pour le développement et le test des API qui simplifie le processus d’envoi de requêtes, d’analyse de réponses et de gestion des API. Il fournit une interface conviviale pour créer et exécuter des appels API, facilitant ainsi le travail des développeurs avec les services web.

Comprendre les services web

Les services web sont des applications ou composants qui communiquent sur des réseaux en utilisant des protocoles web standards. Ces services permettent à différents systèmes logiciels d’interagir et d’échanger des données de manière transparente, quelle que soit leur technologie ou leur plateforme sous-jacente.

Principales caractéristiques des services web

Indépendance de la plateforme : Les services web peuvent être accessibles depuis n’importe quel appareil ou système d’exploitation avec une connexion Internet.
Interopérabilité : Ils permettent à différents systèmes de communiquer en utilisant des protocoles et formats de données standardisés.
Évolutivité : Les services web peuvent gérer plusieurs clients et se développer à mesure que la demande augmente.
Réutilisabilité : Une fois créés, les services web peuvent être utilisés par plusieurs applications, favorisant ainsi la réutilisation du code et l’efficacité.

Qu’est-ce que RPC ?

Le Remote Procedure Call (RPC) est un protocole (JSON-RPC) qui permet à un programme d’exécuter une procédure ou une fonction sur un autre ordinateur comme s’il s’agissait d’un appel de procédure local. Le RPC est l’une des premières formes de calcul distribué et a joué un rôle significatif dans le développement des services web.

Principales caractéristiques du RPC :

Transparence de la localisation : Le programme appelant n’a pas besoin de connaître l’emplacement physique de la procédure appelée.
Communication synchrone : Le RPC suit généralement un modèle de demande-réponse, où l’appelant attend la réponse avant de continuer.
Orienté procédure : Le RPC se concentre sur l’appel de procédures ou de fonctions spécifiques sur des systèmes distants.

Comprendre les API

Une interface de programmation d’application (API) est un ensemble de règles, de protocoles et d’outils permettant à différentes applications logicielles de communiquer entre elles. Les API définissent les méthodes et les formats de données que les applications peuvent utiliser pour demander et échanger des informations.

Types d’API

SOAP (Simple Object Access Protocol) : Un protocole qui utilise XML pour échanger des données structurées.
REST (Representational State Transfer) : Un style architectural qui utilise des méthodes HTTP standard pour la communication.
GraphQL : Un langage de requête pour les API qui permet aux clients de demander les données spécifiques dont ils ont besoin.

Pourquoi les API sont importantes

Intégration : Les API permettent à différents systèmes et applications de fonctionner ensemble de manière transparente.
Flexibilité : Elles permettent aux développeurs d’accéder à des fonctionnalités spécifiques d’autres applications sans avoir besoin de comprendre tout leur code.
Efficacité : Les API peuvent réduire le temps de développement en fournissant des fonctionnalités pré-construites.
Évolutivité : Les API bien conçues peuvent gérer des charges accrues et des bases d’utilisateurs croissantes.

Faire des appels API avec Postman

Maintenant que nous comprenons les bases des services web et des API, explorons comment effectuer des appels API avec Postman. Nous allons parcourir deux exemples pour démontrer différents types d’appels API. https://jsonplaceholder.typicode.com est un site web de test API. Il y en a plus en ligne.

Méthode GET : Une requête pour récupérer des données spécifiques d’un serveur sans modifier les ressources, généralement utilisée pour obtenir des informations et sûre pour des appels répétés.

Méthode POST : Une requête pour soumettre des données à traiter et à stocker par le serveur, souvent utilisée pour créer de nouvelles ressources ou soumettre des données de formulaire, ce qui peut modifier l’état du serveur.

Exemple 1 : Faire une requête GET

Commençons par une simple requête GET pour récupérer des données depuis une API publique.

Ouvrez Postman et créez une nouvelle requête.
Définissez la méthode HTTP sur GET.
Entrez l’URL suivante : https://jsonplaceholder.typicode.com/posts/1
Cliquez sur le bouton “Envoyer”.

Vous devriez recevoir une réponse similaire à celle-ci :

{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

Cet exemple démontre la simplicité de récupération de données à partir d’une API avec Postman. La réponse contient un objet JSON avec des informations sur un post spécifique.

Exemple 2 : Faire une requête POST

Maintenant, créons une nouvelle ressource en utilisant une requête POST.

1. Créez une nouvelle requête dans Postman.

2. Définissez la méthode HTTP sur POST.

3. Entrez l’URL : https://jsonplaceholder.typicode.com/posts

4. Allez dans l’onglet “Body”, sélectionnez “raw” et choisissez “JSON” dans le menu déroulant.

5. Entrez le JSON suivant dans le corps :

jsonCopy{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1
}

Cliquez sur le bouton “Envoyer”.

Vous devriez recevoir une réponse similaire à celle-ci :

jsonCopy{
  "title": "My New Post",
  "body": "This is the content of my new post.",
  "userId": 1,
  "id": 101
}

Cet exemple montre comment créer une nouvelle ressource en utilisant une requête POST. L’API répond avec l’objet créé, y compris un nouvel id attribué par le serveur.

Si le serveur utilise HTTPS et possède un certificat auto-signé, vous pourriez devoir désactiver la vérification des certificats SSL dans les paramètres de Postman.

Fonctionnalités avancées de Postman pour les appels API

Postman propose plusieurs fonctionnalités avancées qui peuvent améliorer votre flux de travail de test et de développement d’API :

Variables d’environnement

Postman vous permet de créer des variables d’environnement pour stocker et réutiliser des valeurs à travers plusieurs requêtes. Cela est particulièrement utile pour gérer différents points de terminaison d’API ou jetons d’authentification.

Pour utiliser les variables d’environnement :

Créez un nouvel environnement dans Postman.
Ajoutez des variables telles que base_url ou api_key.
Utilisez ces variables dans vos requêtes avec des doubles accolades, par exemple, {{base_url}}/api/endpoint.

Scripts pré-requête

Vous pouvez écrire du code JavaScript qui s’exécute avant l’envoi d’une requête. Cela est utile pour générer des données dynamiques ou configurer l’authentification.

Exemple de script pré-requête pour générer un timestamp :

pm.environment.set(“timestamp”, new Date().getTime());

Tests

Postman vous permet d’écrire des tests pour vos appels API en utilisant JavaScript. Ces tests peuvent valider les données de réponse, vérifier les codes de statut ou effectuer d’autres assertions.

Exemple de script de test dans la section Tests de la nouvelle requête GET à https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}} :

// Analyse l'URL pour extraire le timestamp
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Enregistre le timestamp
console.log("Timestamp utilisé :", timestamp);
// Ajoute le timestamp à la réponse pour plus de visibilité
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Définir la réponse modifiée pour visualisation dans Postman
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Teste pour s'assurer que le timestamp a été envoyé
pm.test("Requête envoyée avec timestamp", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Consultez l’onglet “Résultats des tests” pour voir si le test a réussi. Consultez également l’onglet “Console” pour voir le timestamp enregistré. Le corps de la réponse inclura désormais la valeur du timestamp.

Meilleures pratiques pour faire des appels API avec Postman

Organisez vos requêtes : Utilisez des collections et des dossiers pour regrouper les requêtes connexes.
Utilisez le contrôle de version : Postman vous permet d’exporter des collections. Stockez-les dans des systèmes de contrôle de version comme Git.
Documentez vos API : Utilisez la fonctionnalité de documentation de Postman pour créer une documentation API claire et interactive.
Automatisez les tests : Utilisez le Collection Runner de Postman et Newman CLI pour automatiser vos tests API.
Gérez l’authentification correctement : Utilisez des variables d’environnement pour stocker des informations sensibles telles que les clés API ou les jetons.
Surveillez les performances de l’API : Configurez des moniteurs dans Postman pour suivre les performances et le temps de disponibilité de l’API.

Conclusion

Maîtriser les appels d’API avec Postman est une compétence essentielle pour les développeurs et testeurs modernes. En comprenant les services web, les API et le RPC, vous pouvez tirer parti des fonctionnalités puissantes de Postman pour rationaliser vos processus de développement et de test d’API.

Nous avons couvert les bases des appels API, exploré les fonctionnalités avancées de Postman et discuté des meilleures pratiques. Avec ces connaissances, vous êtes bien équipé pour aborder les interactions API complexes et construire des applications robustes et interconnectées.

Rappelez-vous, la clé pour devenir compétent avec les appels d’API Postman est la pratique. Expérimentez avec différents types de requêtes, explorez des API publiques et mettez-vous au défi de créer des suites de tests complètes pour vos propres API.

Alors que vous poursuivez votre parcours dans le développement et le test d’API, envisagez d’explorer des sujets plus avancés tels que la sécurité des API, l’optimisation des performances et les tests d’intégration. Le monde des services web est vaste et en constante évolution, offrant des opportunités d’apprentissage et de croissance infinies.