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 is the fastest way to see what that buys; the guides below cover everything else.
index.html
Copy <!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 > Start with Installation . The configuration reference lists every key with its default; the other guides each go deep on one topic.
What the renderer accepts Format Support OpenAPI 3.0.x / 3.1.x / 3.2.x Rendered natively, webhooks and callbacks included Swagger 2.0 Converted at load OpenAPI Overlay 1.1 Applied to the schema at load Arazzo 1.0 / 1.1 Scenarios import both and export 1.1.0 — and hand off as a generated CI job JSON Schema 2020-12 Keywords rendered in the schema views
The details — conversion, overlays, hiding, the local changelog — live in OpenAPI support & schema control .
Install ApiGlow Install ApiGlow with one script tag: the canonical snippet, openapi.url vs openapi.spec, static hosting, self-hosting from npm, and an agent prompt.
More about Install ApiGlow
Configuration The full ApiGlow config reference: every key of the inline JSON block, its default, and the per-spec override rules for multi-spec installations.
More about Configuration
Theming guide Brand ApiGlow with your own daisyUI theme and no build step: a config entry or a plain CSS block, with theme generator output pasted verbatim.
More about Theming guide
Try-it console guide The try-it console in depth: schema-driven forms, parameter serialization, request imports and exports, history with replay, network insights.
More about Try-it console guide
Try-it & CORS Why the browser blocks a try-it call, how ApiGlow diagnoses it, and the ways through: CORS headers on the API, a proxy you host, cookie credentials.
More about Try-it & CORS
Auth & onboarding Wiring credentials into the try-it console — securitySchemes, OAuth2 PKCE without a backend — and onboarding a teammate with an environment setup link.
More about Auth & onboarding
Authoring scenarios Author ApiGlow scenarios without writing JSON: capture from the try-it, chain by clicking the response, ship with the docs, hand off to CI as a generated job.
More about Authoring scenarios
Docs pages guide Declare Markdown guides in the ApiGlow config: nav groups, body sources, callouts, code tabs, operation cards, {{var}} interpolation, changelogs and feedback.
More about Docs pages guide
Multi-spec guide Document several APIs with one ApiGlow installation: declare openapi.specs, override config per spec with clear merge rules, rely on total isolation.
More about Multi-spec guide
OpenAPI support & schema control What the renderer reads — OpenAPI 3.0 to 3.2, Swagger 2.0, webhooks — and how to shape it: Overlay 1.1, reader-side patches, hiding, the local changelog.
More about OpenAPI support & schema control
Schema audit guide How the in-browser OpenAPI audit works: the five rule categories, severity weights and grade thresholds, deep-linked findings, Markdown export.
More about Schema audit guide
llms.txt & MCP Give agents a way into your API docs: llms.txt and llms-full.txt generated in the browser, an MCP config in three shapes, and a per-endpoint hand-off menu.
More about llms.txt & MCP
SEO & the bake CLI Per-route titles and JSON-LD at runtime, seo.index to stay out — and apiglow bake: static HTML and Markdown mirrors, a sitemap, a served llms.txt.
More about SEO & the bake CLI
FAQ Short answers on ApiGlow: license, privacy, supported OpenAPI versions and browsers, self-hosting from npm, bundle size, CORS, branding, SEO and crawlers.
More about FAQ