Copier la page

Construisez tout, ici.

Quatre étapes, une configuration. Choisissez votre schéma, mettez la marque de l’app à la vôtre avec un thème écrit sur place, décidez ce qu’elle fait, remplissez ce que le schéma ne sait pas dire — puis emportez l’installation finie : deux balises, un bloc JSON, une feuille de style ou un prompt.

Rien n’est envoyé nulle part. La page assemble la configuration dans votre navigateur, garde votre brouillon dans ce navigateur seulement, et l’aperçu transmet sa configuration à l’onglet suivant, pas à un serveur.

Pointez vers votre API

La seule clé dont une configuration ne peut pas se passer, et les noms qui l’entourent.

Une API Plusieurs API

URL du schéma OpenAPI JSON ou YAML, de 3.0.x à 3.2.x. Le serveur qui l’héberge doit autoriser la lecture depuis une autre origine.

C’est votre navigateur qui va chercher le schéma, d’ici. Rien de ce qu’il contient n’arrive jusqu’à ce site.

Nom et logo

branding.productName branding.logoUrl

Ce qu’on laisse de côté

Des motifs qui retirent des opérations de la navigation, de la recherche et des exports : un tag, une méthode et un chemin, un operationId. On masque de la documentation, on ne protège rien — le navigateur télécharge toujours le schéma entier.

openapi.overlays

Des documents OpenAPI Overlay 1.1 appliqués au schéma au chargement, dans l’ordre déclaré.

Décidez ce qu’elle fait

Chaque interrupteur ci-dessous ne quitte sa valeur par défaut que si vous y touchez, et c’est seulement alors qu’il arrive dans la configuration.

features features.scenarios — les scénarios exécutables, leur navigation, leurs boutons de capture features.audit — l’audit du schéma et sa route features.ci — le panneau « Automatiser ce scénario » features.onboarding — une page « Premier appel » générée en tête de la référence

tryIt

tryIt.proxyUrl Un proxy CORS que vous hébergez. « {{target}} » est remplacé par l’URL cible encodée. tryIt.requestCredentials « include » est ce qu’il faut pour une authentification par cookie de session inter-origines.

history

Le premier des deux seuils atteint purge l’historique des requêtes.

history.maxEntries history.maxAgeDays

Robots et verrouillage seo.index — laissez-le actif sauf si cette documentation doit rester hors des résultats de recherche environmentsLocked — retire tout point d’entrée pour créer ou modifier un environnement

Remplissez la documentation

Tout ce que le schéma ne sait pas dire : vos environnements, vos guides, vos annonces, vos scénarios.

environments

Pré-remplis au premier chargement. Ensuite, c’est le stockage du lecteur qui fait foi.

docsPages

Vos pages de prose, tissées dans la navigation à côté de la référence.

announcements

Un bandeau au-dessus de l’en-tête. Markdown en ligne ; une fenêtre de dates le publie et le retire toute seule.

scenarios

Les scénarios livrés avec la documentation, pointant vers des fichiers exportés. En multi-spec, ils se déclarent sur les entrées d’API.

oauth et feedback

L’identifiant client public d’un schéma OAuth2, sous son nom dans securitySchemes. Jamais un secret client — la page hôte est publique.

feedback.url Votre endpoint pour la ligne « Cette page vous a-t-elle aidé ? ». Pas d’URL, pas de ligne.

collez les deux balises dans n’importe quelle page HTML

<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>

Voir en vrai

Écrire toutes les clés, y compris les valeurs par défaut

Construisez tout, ici.

Pointez vers votre API

Mettez-y votre marque

Surfaces

Marque

Neutre

États

Décidez ce qu’elle fait

Remplissez la documentation