OpenAPI¶
DMS publica un esquema OpenAPI cuando la documentación de la API está habilitada.
URLs¶
| URL | Herramienta |
|---|---|
/openapi.json |
Esquema OpenAPI |
/docs |
Swagger UI |
/redoc |
ReDoc |
El acceso se controla por el entorno. No habilites documentación pública de la API en producción a menos que tu organización tenga la intención de exponerla.
Esquema generado¶
El repositorio contiene un docs/openapi.json exportado. Regéneralo con
scripts/export_openapi.py cuando cambie la API.
Seguridad¶
La documentación de la API puede revelar nombres de endpoints, parámetros y modelos. Protégela con los mismos controles de red que la API.