Aller au contenu principal
ApiGlow v0.3.0

Cinq capacités, une balise script.

Un seul bundle, sans backend, sans étape de build. Chaque page dit ce que la capacité fait, comment elle marche, et où elle s’arrête.

Et tout le reste, dans la même balise script.

  • Annonces d’exploitation un bandeau au-dessus de la doc pour une maintenance ou une date de dépréciation — déclaré inline, ou dans un fichier que vos ops éditent sans redéploiement
  • Miroir doc/panneau modifiez la requête depuis la colonne doc ou depuis le panneau, toujours synchronisés
  • Setup links d’environnement accueillez un coéquipier avec une URL — fabriquée de zéro, sans créer l’environnement
  • Correctif local du schéma l’Overlay 1.1 du lecteur, appliqué en dernier et téléchargeable pour être remonté à l’amont
  • Des guides qui se lisent personnellement {{var}} résolue dans la prose depuis l’environnement du lecteur — les valeurs sensibles ne sortent jamais
  • Diagnostic des échecs hors ligne, contenu mixte, CORS ou API injoignable — nommé, pas deviné — et les en-têtes qu’un navigateur refuse d’envoyer, listés
  • Valeurs d’enum expliquées x-enum-descriptions, x-enumDescriptions ou un oneOf de constantes décrites — chaque valeur affichée avec ce qu’elle signifie
  • Lecture des en-têtes de réponse quotas, Retry-After, Deprecation/Sunset, pagination Link, identifiants de corrélation
  • Import d’une requête collez une commande cURL, déposez une collection Postman v2.1 ou un HAR
  • Onboarding « premier appel » une première requête générée, guidée dans la vraie console — opt-in, features.onboarding
  • Historique des requêtes filtrable et rejouable, gardé dans l’IndexedDB du lecteur
  • Sérialisation complète des paramètres style, explode, deepObject, cookies — les parties ingrates, faites correctement
  • Swagger 2.0 converti au chargement, rien à lancer avant
  • Webhooks & callbacks rendus comme des opérations, avec un simulateur de webhook
  • JSON Schema 2020-12 les mots-clés sont rendus, pas ignorés en silence
  • Références circulaires gérées, dans la doc comme dans les exemples générés
  • Masquer les endpoints internes depuis le schéma ou la config — masquage documentaire, pas contrôle d’accès
  • Vos pages de prose vos guides markdown tissés dans la navigation, à côté de la référence
  • Recherche instantanée Cmd+K, une réponse sous 200 ms sur un schéma de 12 Mo et 1220 opérations — budget tenu en CI
  • Interface entièrement localisée une langue tient dans un fichier JSON, téléchargé seulement si elle est active
  • Environnements verrouillables environmentsLocked pour les déploiements d’entreprise encadrés
  • Pont d’identifiants hôte la session SSO de la page devient le jeton du lecteur — à l’exécution, en mémoire, jamais stocké
  • Remise CI un job GitHub Actions ou GitLab CI généré exécute le document Arazzo d’un scénario — des secrets en noms, jamais en valeurs
  • Deux zones de nav nav: bottom envoie les pages support et légales sous la référence — une annexe, pas une seconde doc
  • Accessibilité WCAG 2.2 AA visé sur tous les parcours interactifs — navigation, console, recherche
  • Sans framework composants web natifs, 6 dépendances d’exécution, un seul script
  • Tout reste en local localStorage et IndexedDB uniquement, chaque jeu de données borné