Saltar al contenido principal

Creación de un Servidor Mock de Postman

Esta guía explica cómo utilizar los archivos de ejemplo de Postman proporcionados para crear un entorno de API simulado. Simulará los mismos puntos finales que se muestran en la documentación, sin necesidad de un back-end activo.

Prerrequisitos​

  • Postman (versión de escritorio o web)

  • Tres archivos JSON incluidos con este proyecto:

    • DataPipeline-Environment.json - define variables reutilizables como base_url, mock_base_url, api_token, y stream_id.
    • DataPipeline-postman-collection.json - simula la API de Ingestión en Streaming de la documentación para pruebas reales o por etapas.
    • DataPipeline-MockServer-Collection.json - configura respuestas simuladas para los mismos puntos finales utilizando un Servidor Mock de Postman.

Descarga los tres aquí: Descargar Archivos de Postman

1. Importar los archivos a Postman​

  1. Abre Postman y haz clic en Importar.

  2. Cargar:

    • Las dos colecciones (DataPipeline-postman-collection.json y DataPipeline-MockServer-Collection.json).
    • El entorno (DataPipeline-Environment.json).

  3. Desde el menú de entorno superior derecho, selecciona Data Pipeline Environment.

Ahora deberías ver:

  • Proyecto de Documentación de Data Pipeline
  • Data Pipeline - Colección de Servidores Mock
  • Entorno de Data Pipeline

2. Crear el servidor mock​

  1. Ve a Mock Servers en Postman.
  2. Haz clic en Crear Servidor Mock.
  3. Elige Data Pipeline—Mock Server Collection.
  4. Mantén la configuración predeterminada y haz clic en Crear Servidor Mock.

Postman generará una dirección de servidor mock única, por ejemplo:

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

3. Actualizar la variable de entorno​

  1. Ve a Environments → Data Pipeline Environment.
  2. Busca la variable mock_base_url.
  3. Reemplaza el valor del marcador de posición:
# old
https://mock-server-url-from-postman.io

# new
https://a12b34cd-1234-5678.mock.pstmn.io
  1. Guarda el entorno.

4. Envía tu primera solicitud mock​

  1. Abre POST /v1/streams/ingest dentro de la Mock Server Collection.
  2. Confirma que el entorno está activo.
  3. Haz clic en Enviar.

Deberías ver una respuesta mock 200 OK:

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

5. Probar una respuesta de error​

Elimina un encabezado requerido o edita el cuerpo JSON para activar una respuesta 400 Bad Request.

{
  "error": "invalid_format",
  "detail": "Falta o es inválido el campo 'timestamp'. Se esperaba el formato ISO 8601."
}

6. Visualizando el flujo de la solicitud​

sequenceDiagram
    participant Dev as Postman (Usuario)
    participant Mock as Servidor Mock de Postman
    participant Resp as Respuesta Mock

    Dev->>Mock: POST /v1/streams/ingest
    Note right of Dev: Encabezados: Authorization, X-Stream-Id, Content-Type
    Mock-->>Resp: Simular respuesta JSON 200 o 400
    Resp-->>Dev: Devolver respuesta al cliente Postman

7. Alternar entre pruebas en vivo y mock​

  • Para probar ejemplos "en vivo", usa DataPipeline-postman-collection.json con {{base_url}}.
  • Para probar localmente o sin conexión, usa DataPipeline-MockServer-Collection.json con {{mock_base_url}}.
  • Ambos dependen del mismo DataPipeline-Environment.json para la gestión de variables.

Esto te permite probar tanto tus ejemplos de documentación como la API mock sin cambiar las URLs manualmente.

Por qué es importante​

El uso de Postman Mock Servers y colecciones te permite:

  • Seguir tutoriales y ejemplos de API exactamente como están escritos.
  • Validar formatos de solicitud y respuesta antes del despliegue.
  • Probar entornos reales y simulados con una única configuración.
  • Desarrollar y verificar la documentación junto con el diseño de la API.

Próximos pasos​