Aller au contenu principal

Questions fréquentes.

Les réponses courtes, avec les liens vers les longues. Si la vôtre manque, l’index de la doc recense tous les guides.

C'est gratuit ?

ApiGlow est sous licence MIT, entièrement open source. Pas d’offre payante, pas de version cloud, pas de compte — pas de business model du tout. C’est le principe.

Mon schéma ou mon trafic sortent-ils du navigateur ?

Non. Les requêtes partent directement du navigateur du lecteur vers votre API. Pas d’analytics, pas de télémétrie, pas de serveur chez nous — il n’y a nulle part où envoyer quoi que ce soit. Historique, environnements et scénarios restent dans le stockage du navigateur du lecteur.

Quelles versions d'OpenAPI sont prises en charge ?

OpenAPI 3.0.x, 3.1.x et 3.2.x nativement ; Swagger 2.0 est converti au chargement. OpenAPI Overlay 1.1 s’applique au chargement, et les workflows Arazzo s’importent (1.0 et 1.1) comme s’exportent (1.1.0).

Pourquoi la console d'essai n'atteint-elle pas mon API ?

CORS : votre API doit autoriser l’origine de la documentation. ApiGlow diagnostique l’échec dans l’interface et sait passer par un proxy que vous hébergez (tryIt.proxyUrl) — il n’en fournit aucun. Voir Console d’essai & CORS.

Puis-je le mettre à mes couleurs ?

Nom du produit, logo, thèmes, liens de pied de page — oui. La petite ligne « Powered by » et la boîte « À propos » restent : une installation CDN n’embarque aucun fichier LICENSE, et c’est dans cette boîte que vivent les mentions des composants open source embarqués. Voir le guide des thèmes.

Suis-je dépendant d'un CDN ?

Seulement si vous le voulez bien. npm install apiglow vous donne tout le dossier dist/ : copiez-le dans vos fichiers statiques, pointez la balise script sur votre propre origine, et plus rien n’en sort à l’exécution — aucun tiers dans votre CSP, et la version figée dans votre lockfile. Gardez app.js à côté de son app.css, de i18n/ et de fonts/ : il les résout relativement à lui-même, ce qui explique aussi qu’il ne passe pas par un bundler JavaScript. Voir l’installation.

C'est lourd ?

Un seul fichier : app.js pèse ~289 Ko gzippé en v0.1.0, plus ~39 Ko de CSS ; le pack d’interface français (~24 Ko gzippé) ne se télécharge que si le français est actif. Pas léger — mais c’est le produit entier : cinq dépendances runtime, zéro framework, et dans ce fichier un moteur d’audit, un runner Arazzo, un convertisseur Swagger 2.0, 35 thèmes et des extraits de code en dix langages.

Quels navigateurs sont pris en charge ?

Le plancher déclaré est Chrome/Edge 111, Firefox 128 et Safari/iOS 16.4 — des fonctionnalités de plateforme classées Baseline « widely available », sans polyfill : au-dessus du plancher, tout est détecté et dégradé plutôt que polyfillé. La suite de bout en bout tourne sur Chromium, Firefox et WebKit, desktop et mobile émulé ; Chromium verrouille chaque changement, les autres moteurs tournent à la demande.

C'est rapide sur un gros schéma ?

Les budgets de performance sont imposés en CI contre un schéma de 12 Mo et 1220 opérations — l’API REST GitHub, gelée : utilisable en moins d’une seconde, aucune tâche ne bloque la page plus de 500 ms, une réponse Cmd+K en moins de 200 ms, corps de schéma profonds et pages de prose en moins de 400 ms. Les plafonds ne peuvent que baisser — l’outillage refuse une hausse. La démo accompagne le Petstore d’une seconde spec de 1,15 Mo et 143 opérations — assez grande pour s’y promener, sans infliger 12 Mo de téléchargement à un visiteur.

C'est accessible ?

ApiGlow vise WCAG 2.2 AA sur les parcours interactifs — navigation, console d’essai, recherche — avec un passage axe qui verrouille la CI, contraste des couleurs compris, plus un parcours clavier page entière et une suite de reflow à 320 px : le balayage tourne sur les deux thèmes de l’app et impose le plancher AA comme n’importe quelle autre règle. Pour y arriver, il a fallu faire du texte secondaire une couleur et non une opacité : l’opacité se multiplie le long d’un sous-arbre, et aucun ratio calculé sur un token ne prédit ce qui s’affiche vraiment. Deux limites que le projet énonce lui-même : la promesse de contraste couvre les thèmes qu’il écrit — un ratio corrigé sur sa propre palette ne dit rien des 35 thèmes daisyUI standard qu’il embarque aussi, ni d’un des vôtres — et aucune passe complète au lecteur d’écran n’a encore été faite.

Les moteurs de recherche et les crawlers d'IA lisent-ils la doc ?

D’office, chaque route s’annonce — titres par route, meta description, JSON-LD. Pour les crawlers qui n’exécutent pas de JavaScript, apiglow bake écrit un miroir statique HTML et Markdown de chaque opération, guide et scénario, plus un sitemap et un llms.txt servi — une commande côté auteur, l’installation du lecteur inchangée. Et seo: { index: false } garde une doc interne hors de l’index. Voir SEO & CLI bake.

Puis-je ouvrir la doc depuis une URL file:// ?

Non. L’app est un module ES et télécharge ses ressources, deux choses que le navigateur bloque en file://. N’importe quel serveur statique HTTP(S) convient, y compris en une ligne (python3 -m http.server). Voir l’installation.

Puis-je cacher des endpoints internes ?

Oui — "x-apiglow-hide": true dans le schéma, ou des motifs openapi.hide dans la config ; les opérations cachées disparaissent de la nav, de la recherche et des exports. C’est du masquage documentaire, pas de la sécurité : le navigateur télécharge toujours le schéma complet. Voir Contrôle du schéma.