Saltar a contenido

OpenAPI (public)

La especificacion OpenAPI publica esta filtrada para exponer solo endpoints de consumo (/v1/farmacias/*).

En esta documentacion se incluye como fichero:

  • reference/openapi.json

Y en entornos no-prod, tambien esta disponible desde el servicio en:

  • GET /farmapi/openapi.json (FastAPI con APP_BASE_PATH=/farmapi)

Generar un artefacto para docs

En el repo existe un script para generar el OpenAPI publico en:

  • docs/reference/openapi.json

Ejecuta:

python3 scripts/generate_public_openapi.py

API Reference (Redoc)

La referencia interactiva se abre como pagina dedicada, a pantalla completa: