FONCTIONNALITÉ 04 / 11

Un audit OpenAPI, exécuté là où le schéma est déjà.

Votre documentation a déjà téléchargé le schéma — elle peut donc vous dire ce qui cloche. Ouvrez #/audit et le document chargé est analysé sur place : 38 règles en v0.1.0, cinq catégories, une note de A à F. Il s’adresse à l’auteur de l’API, pas à ses lecteurs.

demo.apiglow.dev/#/audit · petstore.yaml

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

38 règles, cinq catégories.

Exactitude, documentation, obsolescence, cohérence — et « qualité documentaire », la catégorie qu’aucun linter générique n’a : ce qui va réellement se dégrader dans cette documentation rendue. Un résumé d’opération manquant est un point de style abstrait dans un linter ; ici, c’est la ligne vide que vos lecteurs verront dans la navigation.

La note A à 92/100 et les cinq barres de score par catégorie, de l’exactitude à la qualité documentaire. — **[01]**LES CINQ CATÉGORIES, ET LA NOTE QU’ELLES COMPOSENT

Une note sur laquelle agir.

Chaque catégorie reçoit un score, le document une note de A à F. Chaque constat énonce sa raison et pointe directement vers l’opération ou le schéma concerné — vous lisez le constat, vous cliquez, vous regardez le problème.

Un rapport à déposer tel quel.

Le rapport s’exporte en Markdown, prêt à coller dans une issue ou une revue. Et quand le constat vit dans un schéma qui ne vous appartient pas, les overlays le corrigent au chargement — auditer, corriger, recharger, ré-auditer.

Le bouton d’export Markdown du rapport. — **[03]**UN BOUTON, LE RAPPORT DANS LE PRESSE-PAPIERS

Dans le navigateur, pour l’auteur.

Rien n’est calculé tant que personne n’ouvre #/audit, et rien n’est envoyé nulle part — l’analyse porte sur le schéma que la page a déjà téléchargé. Parce qu’il vise l’auteur, pas d’entrée dans la navigation : le seul point d’accès est un bloc en bas du panneau de réglages, hors du chemin de vos lecteurs. Une fois le schéma amélioré, le suivi des changements montre à vos lecteurs ce qui a bougé.

Les installations qui n’en veulent pas posent une clé — la route, le bloc de réglages et tout calcul disparaissent.

Retirer l’audit entièrement

{ "features": { "audit": false } }

Voyez-le dans la démo.

Ouvrir la démo Lire le guide de l’audit de schéma