Aller au contenu
Restorm Documentation Restorm

Détecter les problèmes d'une API importée

Lorsque vous importez une API (OpenAPI, Swagger et les autres formats pris en charge), Restorm conserve la documentation structurée de l’API sur son dossier de variables. Juste après l’import — et à chaque réouverture du fichier —, Restorm projette discrètement cette documentation en design et exécute la même validation que le concepteur d’API, entièrement en tâche de fond. Cela ne bloque jamais l’import et n’interrompt jamais ce que vous faites.

S’il ne trouve rien, vous ne voyez rien. S’il détecte des problèmes structurels, il vous les signale à deux endroits.

Le « ! » dans la barre latérale

Section titled “Le « ! » dans la barre latérale”

Le dossier de variables qui porte l’API signalée affiche un petit « ! » à droite de sa ligne. C’est le repère d’un coup d’œil indiquant que la conception de cette API mérite un examen — et il disparaît de lui-même dès que l’API est de nouveau saine (après un ré-import ou une mise à jour d’API qui la corrige).

L’onglet « Problèmes »

Section titled “L’onglet « Problèmes »”

Ouvrez le dossier de variables : il gagne un onglet Problèmes. Cet onglet n’apparaît que si des problèmes ont été détectés — une API saine ne l’affiche jamais.

L'onglet Problèmes du dossier de variables d'une API importée : un encadré d'avertissement, puis les problèmes groupés par type — « Plusieurs routes répondent à la même méthode et au même chemin », « Des routes ne déclarent aucune réponse », « Des routes occupent un chemin réservé par le serveur de design » — chacun listant les routes exactement concernées, l'une dépliée pour montrer la documentation de cette route

Les problèmes sont groupés par type : vingt routes en double se lisent comme une seule ligne avec un compteur plutôt que vingt entrées séparées. Sous chaque type, Restorm liste les entités exactement concernées — une route affiche son verbe HTTP et son vrai chemin, et se déplie sur la documentation de cette route pour que vous voyiez ce qu’elle déclare sans quitter l’onglet.

Les contrôles reprennent ceux du concepteur d’API ; les types de problèmes que vous pouvez voir incluent donc :

  • routes en double — deux routes répondant à la même méthode et au même chemin ;
  • réponses manquantes — une route qui ne déclare aucune réponse ;
  • chemins réservés — une route occupant un chemin réservé par le serveur de mock (/swagger.json, /graphql, …), qui ne répondrait jamais ;
  • problèmes de contraintes — un motif invalide, ou un minimum supérieur au maximum.

La liste est en lecture seule : elle vous indique quoi corriger, et vous corrigez à la source (ré-importez une spécification corrigée, ou modifiez l’API). Elle est recalculée sur les événements qui changent une API — ouverture d’un fichier, import, mise à jour d’API — pas à chaque frappe.