Origen del OpenAPI estático¶
Scalar en este sitio no consume el endpoint en tiempo de ejecución. Lee el archivo estático:
- Publicado en el sitio:
/openapi/v1.json - Archivo en el repositorio:
docs/mkdocs/openapi/v1.json
URL del gateway (origen del spec)¶
La URL base se resuelve con esta precedencia:
- Variable de entorno
KORDATA_GATEWAY_URL(pipeline / deploy por ambiente) mkdocs.yml→extra.kordata_gateway_url(desarrollo local)
Si ninguna está definida, la sincronización y el build fallan.
| Ambiente | Ejemplo de valor |
|---|---|
| QA | https://qa-api.kordata.mx |
| Producción | https://api.kordata.mx |
El script descarga desde {gateway}/openapi/v1?server={gateway}.
El parámetro server indica al backend qué URL debe incluir en servers[] del spec generado. Ejemplo:
Regenerar el JSON estático¶
Con el gateway accesible:
# Linux / macOS / pipeline
export KORDATA_GATEWAY_URL=https://qa-api.kordata.mx # opcional si está en mkdocs.yml
./scripts/sync-openapi.sh
Luego reinicie o recargue mkdocs serve, o ejecute mkdocs build.
En CI/CD, ver azure-pipelines.yml en la raíz del repositorio.