Aller au contenu principal
FONCTIONNALITÉ 10 / 11

Votre prose emménage avec la référence.

Guides, tutoriels, notes d’architecture — des fichiers Markdown déclarés en une ligne et rendus dans le navigateur comme tout le reste. Ils partagent la navigation, le thème, la langue et la recherche avec la référence, et savent pointer directement dedans.

demo.apiglow.dev/#/docs/getting-started · petstore.yaml
Un guide de prose rendu dans la doc : cartes d'opération vers deux endpoints, exemples de code en onglets et un callout IMPORTANT, avec le sommaire de page à droite. Un guide de prose rendu dans la doc : cartes d'opération vers deux endpoints, exemples de code en onglets et un callout IMPORTANT, avec le sommaire de page à droite.

CAPTURE RÉELLE, AFFICHÉE À 1:1

Déclarées en une ligne, tissées dans la nav.

Une entrée docsPages, c’est un titre et un corps — une URL de fichier, du content inline, ou l’id d’un élément script déjà présent dans votre page hôte. L’ordre du tableau fait l’ordre de la navigation ; les entrées peuvent former un niveau de groupes, pointer vers des URL externes, ou venir d’un manifeste JSON produit par votre pipeline. Un README ou un CHANGELOG existant marche tel quel : le frontmatter écrit pour un autre outil est retiré, pas affiché.

Et la nav a deux zones : nav: "bottom" sur une entrée de premier niveau l’envoie en annexe au pied de la barre latérale, sous toute la référence API — les pages support et légales cessent de repousser les endpoints.

Des pages, un groupe, un lien externe — et une zone d'annexe
{ "docsPages": [
  { "title": "Bien démarrer", "url": "./bien-demarrer.md", "home": true },
  { "group": "Guides", "pages": [
    { "title": "Pagination", "url": "./pagination.md" } ] },
  { "title": "État du service", "href": "https://status.example.com",
    "nav": "bottom" } ] }

Vos pages parlent à la référence.

Un [lien](apidoc:createOrder) se rend en ligne avec le badge de méthode de l’opération et mène à sa documentation — par operationId ou par "MÉTHODE /chemin", webhooks compris. Un bloc de code listant des références devient une rangée de cartes d’opération : méthode, chemin, résumé, badge de dépréciation. Une référence introuvable s’affiche visiblement cassée plutôt que de devenir un lien mort.

Écrites pour des lecteurs, pas pour une étape de build.

Les callouts façon GitHub (> [!NOTE] jusqu’à [!CAUTION]) deviennent de vraies alertes — et se dégradent en simples citations partout ailleurs où vit votre Markdown. Des blocs de code adjacents deviennent des onglets, et un choix de langage suit le lecteur dans tous les groupes d’onglets de la page. Ni plugin, ni build : c’est le même fichier que GitHub sait afficher.
Trois blocs de code adjacents rendus en onglets cURL / Node.js / Python. Trois blocs de code adjacents rendus en onglets cURL / Node.js / Python.
[03]DES BLOCS ADJACENTS DEVIENNENT DES ONGLETS

Le guide se lit avec les valeurs du lecteur.

{{var}} se résout dans la prose depuis l’environnement que la console d’essai utilise déjà : un guide se rend donc avec l’URL de base du lecteur et son identifiant de tenant — et le bouton de copie d’un bloc copie ce qui a été résolu, parce que ce qu’on colle doit tourner. De la documentation personnalisée, sans serveur, sans compte et sans chaîne de rendu. Les valeurs sensibles sont la seule chose qui n’apparaît jamais : elles se rendent en pastille masquée, et la valeur n’atteint ni la page, ni le presse-papiers, ni l’index de recherche, ni aucun export — non pas caviardée après coup, jamais émise. Une variable sans valeur affiche une pastille qui ouvre le gestionnaire d’environnements, parce que la définir est la seule suite possible.
Ce que vous écrivez — le lecteur voit ses propres valeurs
Toutes les requêtes vont vers `{{baseUrl}}`, authentifiées
avec votre clé :

```bash
curl -H "X-Tenant: {{tenant}}" {{baseUrl}}/pets
```

Le confort vient avec.

Chaque page de prose reçoit un sommaire qui suit votre défilement, une pagination précédent/suivant dans l’ordre de la nav, et sa place dans la palette Cmd+K : titres et corps sont indexés — paresseusement, à la première recherche, pour que les pages que personne ne cherche ne soient jamais téléchargées. Titres et corps acceptent des variantes par langue, et une page home: true prend la route d’accueil (la vue d’ensemble technique déplacée garde sa propre route). Marquez une page kind: "changelog" et ses versions se rendent en frise. La même prose voyage aussi avec les exports de la surface IA.
Un callout « Important » rendu depuis la syntaxe de citation GitHub-flavored Markdown. Un callout « Important » rendu depuis la syntaxe de citation GitHub-flavored Markdown.
[05]UN CALLOUT GFM, RENDU

Demandez à vos lecteurs, et soyez seul à écouter.

Pointez feedback.url vers un endpoint à vous et chaque page gagne une ligne « Cette page vous a-t-elle été utile ? ». Un clic envoie { "page": "pagination", "verdict": "up" } à votre serveur — le slug de la page et un pouce, rien d’autre. Laissez la clé de côté, comme elle est livrée, et la ligne n’existe pas. C’est la seule chose dans ApiGlow qui envoie jamais le geste d’un lecteur quelque part ; elle va où vous avez dit et nulle part ailleurs, et il n’y a aucun produit à nous au bout du fil pour le récolter.
La seule ligne qui vous y engage
{ "feedback": { "url": "https://example.com/docs-feedback" } }

Où ça s'arrête.

Les cartes d’opération sont des liens vers la référence, pas des consoles d’essai embarquées — l’exécution des requêtes reste dans la console d’essai, par choix. Les groupes tiennent sur un niveau : un manifeste qui tente d’imbriquer plus profond est rejeté avec un avertissement en console, pas aplati en silence.