OpenAPI

Récupérez le contrat généré de l'API admin Miravo depuis le runtime ou le dépôt, puis réutilisez le même schéma dans vos outils.

Miravo génère un seul document OpenAPI pour l'API admin. Le même contrat alimente la route runtime /openapi.json, l'artefact versionné docs/api/openapi.json et la table de routes admin générée pour la console.

Récupérer le document live

curl -s http://127.0.0.1:8080/openapi.json | jq .

GET /openapi.json ne demande pas d'authentification.
Les binaires standalone servent une copie embarquée du document.
Le serveur admin par défaut publie la route sur le port 8080.

Régénérer depuis la source

bun run gen:openapi

Les métadonnées de routes vivent dans packages/shared/src/admin/endpoints.ts.
L'enregistrement des schémas vit dans packages/shared/src/admin/openapi-registry.ts.
L'artefact généré est écrit dans docs/api/openapi.json.
La même commande régénère packages/console/src/lib/admin-client.generated.ts.

Pages liées

API admin

Groupes de routes, frontière d'authentification et comportement runtime.

Docker

Publiez le port admin et récupérez la spécification depuis un conteneur.

CLI ⭢ miravo start

Hôte admin, port, mode détaché et options runtime.

Was this page useful?