open source · MIT · v0.3.0
Une doc d’API qui sait exécuter. s’auditer. rejouer. se souvenir.
Envoyez la requête, déroulez le scénario, notez le schéma — depuis la page même qui les documente. Une balise script, aucun build, rien n’est envoyé.
Rien n’est envoyé nulle part : c’est votre navigateur qui va chercher le schéma. Laissez vide pour la démo Petstore.
Une page de référence, plus de quoi s’en servir.
Tout se passe dans le navigateur du lecteur, sur le schéma que la page a déjà chargé.
L’envoyer
Une vraie console : environnements, secrets masqués, historique rejouable et dix langages d’extrait.
En savoir plus →L’exécuter
Les workflows Arazzo 1.1 se déroulent pas à pas dans la page, chaînés sans une ligne de script.
En savoir plus →Le noter
137 règles notent le schéma — sécurité et préparation aux agents comprises — dans la page, et les mêmes font échouer le build en CI.
En savoir plus →Ça s’installe comme une feuille de style.
Pas de Node, pas de bundler, pas d’étape de build, pas de compte. Une balise script et une balise JSON, dans une page que vous avez déjà.
295 Ko
gzippé, un seul fichier
1075 Ko brut
41 Ko
de feuille de style
37 thèmes dedans
1,1 s
pour être utilisable
12 Mo · 1220 opérations
61 ms
réponse ⌘K
sur ce même schéma
<!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>Six dépendances, aucun framework. Temps mesurés sur l’API REST de GitHub, figée, processeur ralenti quatre fois.
Pas besoin d’écrire ce JSON à la main. Les quatre stations du builder couvrent toutes les clés — rien ne quitte votre navigateur.
Le schéma
openapi · hide · overlays
Votre URL, ou plusieurs API dans une installation — moins ce que la doc ne doit pas montrer.
Le thème
theme.custom
Votre propre thème daisyUI, à partir de l’un des 37 embarqués, avec 13 paires de contraste notées au fil.
Comportement
features · tryIt · seo
Ce que le lecteur reçoit de l’application, et comment la console envoie.
Contenu
environments · docsPages
Ce que le schéma ne peut pas dire — environnements, guides, bandeaux, scénarios.
Notez le schéma dans la doc. Imposez-le en CI.
Un audit, deux endroits. La page note le document qu’elle a déjà chargé ; les mêmes règles, en une ligne npx, font échouer le merge qui le dégrade.
- 137 règles en sept catégories, sécurité et préparation aux agents comprises (v0.3.0)
- Une note de A à F, et un correctif pour chaque constat
- Les mêmes règles dans la page et en CI — les deux notes concordent
- Une baseline versionnée — le build n’échoue que sur les nouveaux constats
- SARIF, annotations GitHub, GitLab Code Quality, et du JSON pour les scripts et les agents
- En savoir plus sur l’audit →
note globale · audit de schéma
npx apiglow@0.3.0 audit openapi.yaml \
--baseline audit-baseline.json --min-grade B
PASS --fail-on error: 0 new finding(s) at this severity or above
PASS --min-grade B: grade A
PASS --baseline: no stale entry
Audit passedLe vrai passage sur le schéma de démo. Code de sortie 1 quand un contrôle échoue — et les constats s’affichent sur le diff de la pull request.
Il lit les formats, et il les réécrit.
OpenAPI 3.0 · 3.1 · 3.2
Rendus nativement, y compris la méthode query de 3.2. Swagger 2.0 est converti au chargement.
JSON Schema 2020-12
Les mots-clés sont rendus plutôt que silencieusement ignorés, références circulaires comprises.
Overlay 1.1
Appliqué avant la conversion — et un lecteur peut écrire le sien, puis l’emporter en fichier.
Arazzo 1.1
Importé, exécuté dans la page, exporté en job CI pour GitHub Actions ou GitLab.
llms.txt · MCP
L’index, le texte intégral et une configuration de serveur MCP, générés côté client.
Miroir statique
Une commande côté auteur écrit une page HTML et Markdown par route, sans aucun serveur.
La référence, et tout ce qui l’entoure.
Guides, marque et plusieurs API vivent dans la même page que la référence.
Vos pages de prose
Des guides Markdown avec encarts, onglets de code et cartes d’opération — résolus avec l’environnement du lecteur.
En savoir plus →Votre marque, sans rebuild
Trente-cinq thèmes sont livrés avec, et le vôtre tient dans un bloc de variables CSS sur la page hôte.
En savoir plus →Plusieurs API, une page
Chaque schéma garde ses environnements, son historique et sa portée de recherche, sans fuite entre eux.
En savoir plus →La même balise, aux couleurs d'un autre.
Northwind Rail est un transporteur que nous avons inventé. Son portail, lui, n'est pas une maquette : la référence, les guides et un bac à sable qui répond viennent tous d'une seule balise de script — la même que vous ajouteriez.
- 18 opérations
- 8 guides · EN + FR
- 2 scénarios enchaînés
- un bac à sable dans le navigateur
Certains de vos lecteurs ne sont pas humains.
Un développeur qui travaille avec un assistant a besoin de la documentation dans une forme que l’assistant peut avaler. ApiGlow produit ces fichiers depuis le schéma chargé, côté client : il n’appelle aucun modèle et ne fait tourner aucun serveur.
llms-full.txt
Toute la documentation en un seul fichier Markdown — informations, serveurs, pages de prose, chaque opération et chaque webhook.
llms.txt
L’index du même contenu, selon la convention llmstxt.org — un lien par opération et par webhook.
Config de serveur MCP
Un bloc JSON, une ligne claude mcp add, ou un lien d’installation Cursor/VS Code. Les identifiants en ressortent sous forme de marqueurs.
Ouvrez-le sur un vrai schéma. Ou sur le vôtre.
Un schéma de 1,15 Mo et 143 opérations, avec une API simulée derrière — ou le vôtre, collé plus haut.