Aller au contenu principal
ApiGlow v0.1.0
FR

Une balise script, documentée de bout en bout.

ApiGlow génère une documentation d’API interactive à l’exécution, dans le navigateur, depuis un schéma OpenAPI. Une page HTML, une config JSON inline, un <script> servi par un CDN — pas d’étape de build, pas de backend, pas de compte. La démo est le plus court chemin pour voir ce que ça donne ; les guides ci-dessous couvrent le reste.

index.html 
<!doctype html>
<html>
  <head><title>My API docs</title></head>
  <body>
    <script id="api-doc-config" type="application/json">
    { "openapi": { "url": "https://example.com/openapi.json" } }
    </script>
    <script src="https://cdn.jsdelivr.net/npm/apiglow@0.1.0/dist/app.js" type="module"></script>
  </body>
</html>

Commencez par l’installation. La référence de configuration liste chaque clé avec sa valeur par défaut ; les autres guides creusent chacun un sujet.

Ce que le moteur accepte

FormatPrise en charge
OpenAPI 3.0.x / 3.1.x / 3.2.xRendu natif, webhooks et callbacks compris
Swagger 2.0Converti au chargement
OpenAPI Overlay 1.1Appliqué au schéma au chargement
Arazzo 1.0 / 1.1Les scénarios importent les deux, exportent du 1.1.0 — et se remettent en job CI généré
JSON Schema 2020-12Mots-clés rendus dans les vues de schéma

Le détail — conversion, overlays, masquage, changelog local — vit dans Couverture OpenAPI & contrôle du schéma.