Skip to main content

Pruebas de API con Postman

Esta sección describe cómo usar las colecciones de Postman para probar los endpoints expuestos por el BFF (bff-api) de la plataforma apolo-app-platcom-platform.

⚠️ Todas las colecciones están pensadas para invocar los endpoints expuestos por el BFF. No llaman directamente a los microservicios internos.

Ubicación de las colecciones​

Las colecciones y el environment se encuentran en:

docs/postman/
└── collections/
    ├── ADMIN APPLICATIONS.postman_collection.json
    ├── APPLICATIONS.postman_collection.json
    ├── AUTH.postman_collection.json
    ├── EXTERNAL SUPPLIER.postman_collection.json
    ├── LOCAL.postman_environment.json
    ├── PLANS.postman_collection.json
    ├── PLAYGROUND API.postman_collection.json
    ├── REPORTS.postman_collection.json
    ├── ROLES.postman_collection.json
    ├── SCOPES.postman_collection.json
    ├── SUPPLIERS.postman_collection.json
    ├── TENANT.postman_collection.json
    └── TEST_MDH SERVICES.postman_collection.json

Configuración inicial en Postman​

  1. Instala Postman
    Descarga la última versión desde https://www.postman.com/downloads/
  2. Importa las colecciones
    • En Postman, haz clic en Collections → Import.
    • Selecciona los archivos *.postman_collection.json ubicados en docs/postman/collections/.
    • Cada archivo se importará como una colección independiente.

Uso recomendado​

  1. Seleccionar el environment correcto​

    • Asegúrate de tener seleccionado el environment LOCAL (o el que hayas configurado) antes de ejecutar cualquier request.

  2. Configurar tokens de autenticación​

    • Algunos endpoints requieren un token JWT (Bearer) en el header Authorization.
    • Usa primero los requests de la colección AUTH para obtener un token.
    • Actualiza la variable de entorno correspondiente (por ejemplo token, AUTH_TOKEN o authorization`) y reutilízala en el resto de colecciones.

  3. Ejecutar requests por dominio​

    • Navega a la colección correspondiente (por ejemplo, APPLICATIONS o REPORTS).
    • Usa las carpetas internas para seguir los flujos sugeridos (listar, crear, actualizar, etc.).
    • Valida los códigos de respuesta, payloads y headers según la documentación de cada endpoint.

  4. Combinar Postman con Swagger​

    • Usa el Swagger expuesto desde el BFF para consultar el contrato actualizado de los endpoints (paths, schemas, responses).
    • Usa las colecciones Postman como base práctica para probar esos endpoints desde un entorno local o remoto.

Buenas prácticas​

  • Mantener el environment sin credenciales sensibles dentro del repositorio (usar valores genéricos o placeholders).
  • Actualizar las colecciones cuando se agreguen nuevos endpoints o se modifique el contrato del BFF.
  • Documentar dentro de las descripciones de las requests cualquier requisito adicional (headers específicos, IDs de prueba, etc.).