Aller au contenu principal

Création d'un serveur fictif Postman

Ce guide explique comment utiliser les fichiers d'exemple Postman fournis pour créer un environnement API fictif. Vous simulerez les mêmes points de terminaison que ceux présentés dans la documentation, sans avoir besoin d'un back-end en direct.

Prérequis​

  • Postman (version bureau ou Web)

  • Trois fichiers JSON sont inclus dans ce projet :

    • DataPipeline-Environment.json - définit les variables réutilisables telles que base_url, mock_base_url, api_token et stream_id.
    • DataPipeline-postman-collection.json - simule l'API Streaming Ingest de la documentation pour des tests réels ou simulés.
    • DataPipeline-MockServer-Collection.json - configure les réponses simulées pour les mêmes points de terminaison à l'aide d'un serveur Postman Mock.

Téléchargez les trois fichiers ici : Télécharger les fichiers Postman

1. Importez les fichiers dans Postman​

  1. Ouvrez Postman et cliquez sur Importer (Import).

  2. Sélectionnez les fichiers JSON téléchargés :

    • Les deux collections (DataPipeline-postman-collection.json e DataPipeline-MockServer-Collection.json).
    • L'environnement (DataPipeline-Environment.json).

  3. Dans le menu Environnement en haut à droite, sélectionnez Environnement Data Pipeline (Data Pipeline Environment).

Vous devriez maintenant voir :

  • Documentation Data Pipeline Projet
  • Data Pipeline - Collection Mock Server
  • Environnement Data Pipeline

2. Créer le serveur fictif​

  1. Accédez à Mock Servers dans Postman.
  2. Cliquez sur Create Mock Server.
  3. Choisissez Data Pipeline—Mock Server Collection.
  4. Conservez les paramètres par défaut et cliquez sur Create Mock Server.

Postman générera une adresse de serveur fictif unique, par exemple :

https://a12b34cd-1234-5678.mock.pstmn.io

3. Mettre à jour la variable d'environnement​

  1. Accédez à Environments → Data Pipeline Environment.
  2. Recherchez la variable mock_base_url.
  3. Remplacez la valeur du paramètre fictif :
# ancien
https://mock-server-url-from-postman.io

# nouveau
https://a12b34cd-1234-5678.mock.pstmn.io
  1. Enregistrez l'environnement.

4. Envoyez votre première requête simulée​

  1. Ouvrez POST /v1/streams/ingest dans la collection de serveurs simulés (Mock Server Collection).
  2. Vérifiez que l'environnement est actif.
  3. Cliquez sur Envoyer (Send).

Vous devriez voir une réponse simulée 200 OK :

{
  "status": "accepted",
  "ingested_bytes": 204,
  "stream_id": "demo-stream-001",
  "message": "Événement reçu avec succès par le serveur simulé."
}

5. Testez une réponse d'erreur​

Supprimez un en-tête requis ou modifiez le corps JSON pour déclencher une réponse 400 Bad Request.

{
  "error": "invalid_format",
  "detail": "Champ « timestamp » manquant ou non valide. Format ISO 8601 attendu."
}

6. Basculer entre les tests en direct et les tests simulés​

  • Pour tester des exemples « en direct », utilisez DataPipeline-postman-collection.json avec {{base_url}}.
  • Pour tester localement ou hors ligne, utilisez DataPipeline-MockServer-Collection.json avec {{mock_base_url}}.
  • Les deux s'appuient sur le même fichier DataPipeline-Environment.json pour la gestion des variables.

Cela vous permet de tester à la fois vos exemples de documentation et l'API simulée sans modifier manuellement les URL.

Visualisation du flux de requêtes​

sequenceDiagram
    participant Dev as Postman (Utilisateur)
    participant Mock as Serveur fictif Postman
    participant Resp as Réponse fictive

    Dev->>Mock: POST /v1/streams/ingest
    Note right of Dev: En-têtes : Authorization, X-Stream-Id, Content-Type
    Mock-->>Resp: Simuler une réponse JSON 200 ou 400
    Resp-->>Dev: Renvoyer la réponse au client Postman

Pourquoi est-ce important ?​

L'utilisation des serveurs de simulation et des collections Postman vous permet de :

  • Suivre les tutoriels et les exemples d'API exactement tels qu'ils sont écrits.
  • Valider les formats de requête et de réponse avant le déploiement.
  • Tester à la fois les environnements réels et simulés avec une seule configuration.
  • Développer et vérifier la documentation parallèlement à la conception de l'API.