Swagger (Documentación de APIs)
La documentación de las APIs de apolo-app-platcom-platform se expone de forma centralizada a través del servicio bff-api.
Desde este punto de entrada se publican todos los endpoints disponibles de la plataforma, incluyendo los distintos dominios (auth, applications, core, reports, tenants, etc.).
🔎 Importante: no se accede a Swagger directamente desde cada microservicio, sino únicamente a través del BFF (
bff-api), que actúa como puerta de entrada unificada.
Acceso a Swagger en entorno local
- Levanta la infraestructura base (MongoDB, Redis, Kafka, etc.):
docker compose up -d
Inicia el BFF:
npx nx serve bff-api
Accede a Swagger desde tu navegador en la URL configurada para el BFF, por ejemplo:
http://localhost:8080/swagger
¿Qué expone el Swagger del BFF?
El Swagger servido por bff-api concentra la definición de los endpoints expuestos por la plataforma, entre ellos:
- Auth: autenticación, login, logout, gestión de usuarios, scopes, recuperación de contraseña, etc.
- Applications: gestión de aplicaciones/módulos del ecosistema.
- Core: operaciones de dominio central.
- Reports: generación y descarga de reportes.
- Tenants: gestión de tenants / entornos multi-organización.
- Otros módulos que se vayan incorporando al BFF.
Esto permite a los desarrolladores:
- Explorar los endpoints disponibles.
- Ver parámetros, cuerpos de request y responses.
- Probar requests directamente desde la UI de Swagger (en entornos donde esté habilitado).
Autenticación en Swagger
La mayoría de los endpoints expuestos requieren autenticación mediante token Bearer:
- El header se envía como:
Authorization: Bearer <token_jwt>
- El token se obtiene a través de los flujos de autenticación implementados en `auth-api (o mediante el flujo corporativo definido para el entorno).
En la UI de Swagger, normalmente puedes:
- Pulsar en el botón Authorize.
- Introducir el token en el formato:
Bearer <token_jwt>
Confirmar y ejecutar los endpoints protegidos.