Aller au contenu principal

Création d'un serveur fictif Postman

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

Prérequis​

  • Postman (version bureau ou web)

  • Trois fichiers JSON inclus dans ce projet :

    • DataPipeline-Environment.json - définit des 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 par étapes.
    • DataPipeline-MockServer-Collection.json - configure des réponses fictives pour les mêmes points de terminaison en utilisant un serveur fictif Postman.

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

1. Importer les fichiers dans Postman​

  1. Ouvrez Postman et cliquez sur Import.

  2. Charger :

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

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

Vous devriez maintenant voir :

  • Projet de documentation de Data Pipeline
  • Data Pipeline - Collection de serveurs fictifs
  • Environnement de Data Pipeline

2. Créer le serveur fictif​

  1. Allez dans Serveurs fictifs dans Postman.
  2. Cliquez sur Créer un serveur fictif.
  3. Choisissez Data Pipeline-Mock Server Collection.
  4. Conservez les paramètres par défaut et cliquez sur Create Mock Server.

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

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

3. Mise à jour de la variable d'environnement​

  1. Allez dans Environnements → Data Pipeline Environment.
  2. Trouvez la variable mock_base_url.
  3. Remplacez la valeur de l'espace réservé :
# old
https://mock-server-url-from-postman.io

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

4. Envoyez votre première demande fictive​

  1. Ouvrez POST /v1/streams/ingest dans la Collection de serveurs fictifs.
  2. Confirmez que l'environnement est actif.
  3. Cliquez sur Send.

Vous devriez voir une réponse fictive 200 OK :

{
  "status" : "accepted",
  "ingested_bytes" : 204,
  "stream_id" : "demo-stream-001",
  "message" : "Event successfully received by mock server".
}

5. Tester 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 invalide. Format ISO 8601 attendu."
}

6. Visualisation du flux de demandes​

sequenceDiagram
    participant Dev as Postman (User)
    participant Mock as Postman Mock Server
    participant Resp as Mock Response

    Dev->>Mock: POST /v1/streams/ingest
    Note right of Dev: Headers: Authorization, X-Stream-Id, Content-Type
    Mock-->>Resp: Simulate 200 or 400 JSON response
    Resp-->>Dev: Return response to Postman client

7. Basculer entre le test réel et le test fictif​

  • Pour tester les exemples "live", 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 DataPipeline-Environment.json pour la gestion des variables.

Cela vous permet de tester à la fois vos exemples de documentation et l'API fictive sans changer les URLs manuellement.

Pourquoi c'est important​

L'utilisation de Postman Mock Servers et de collections vous permet de :

  • Suivre les tutoriels et les exemples d'API exactement comme ils sont écrits.
  • Valider les formats de demande et de réponse avant le déploiement.
  • Tester 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.

Prochaines étapes​