Skip to main content
ApiGlow v0.3.0
Copy page

One script tag, documented end to end.

ApiGlow renders interactive API documentation at runtime, in the browser, from an OpenAPI schema. One HTML page, one inline JSON config, one <script> from a CDN — no build step, no backend, no account. The live demo shows what that gets you; the guides below cover the rest.

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.3.0/dist/app.js" type="module"></script>
  </body>
</html>

Start with Installation. The configuration reference lists every key with its default, and the other guides each go deep on one topic.

What the renderer accepts

FormatSupport
OpenAPI 3.0.x / 3.1.x / 3.2.xRendered natively, webhooks and callbacks included
Swagger 2.0Converted at load
OpenAPI Overlay 1.1Applied to the schema at load
Arazzo 1.0 / 1.1Scenarios import both and export 1.1.0, and hand off to CI as a generated job
JSON Schema 2020-12Keywords rendered in the schema views

The details — conversion, overlays, hiding, the local changelog — live in OpenAPI support & schema control.