Probleme in einer importierten API erkennen

Wenn Sie eine API importieren (OpenAPI, Swagger und die anderen unterstützten Formate), bewahrt Restorm die strukturierte Dokumentation der API in ihrem Umgebungsordner auf. Direkt nach dem Import — und bei jedem erneuten Öffnen der Datei — projiziert Restorm diese Dokumentation unauffällig in ein Design und führt dieselbe Validierung durch wie der API-Designer, vollständig im Hintergrund. Das blockiert nie den Import und unterbricht nie, was Sie gerade tun.

Findet Restorm nichts, sehen Sie nichts. Findet es strukturelle Probleme, weist es Sie an zwei Stellen darauf hin.

Das „!“ in der Seitenleiste

Der Umgebungsordner, der die markierte API trägt, zeigt rechts in seiner Zeile ein kleines „!“. Es ist das Signal auf einen Blick, dass das Design dieser API einen Blick wert ist — und es verschwindet von selbst, sobald die API wieder sauber ist (nach einem erneuten Import oder einer API-Aktualisierung, die es behebt).

Der Tab „Probleme“

Öffnen Sie den Umgebungsordner, erhält er einen Tab „Probleme“. Der Tab erscheint nur, wenn Probleme erkannt wurden — eine saubere API zeigt ihn nie.

Probleme werden nach Typ gruppiert, sodass zwanzig doppelte Routen als eine Zeile mit einer Anzahl erscheinen statt als zwanzig einzelne Einträge. Unter jedem Typ listet Restorm die genau betroffenen Entitäten auf — eine Route zeigt ihr HTTP-Verb und ihren echten Pfad und klappt zur Dokumentation dieser Route auf, sodass Sie sehen, was sie deklariert, ohne den Tab zu verlassen.

Die Prüfungen entsprechen denen des API-Designers, daher gehören zu den Problemen, die Ihnen begegnen können:

• doppelte Routen — zwei Routen, die dieselbe Methode und denselben Pfad beantworten;
• fehlende Antworten — eine Route, die überhaupt keine Antwort deklariert;
• reservierte Pfade — eine Route, die auf einem Pfad liegt, den der Mock-Server reserviert (/swagger.json, /graphql, …) und der nie antworten würde;
• Constraint-Probleme — ein ungültiges Muster oder ein Minimum über seinem Maximum.

Die Liste ist schreibgeschützt: Sie sagt Ihnen, was zu beheben ist, und Sie beheben es an der Quelle (importieren Sie eine korrigierte Spezifikation erneut oder bearbeiten Sie die API). Sie wird bei den Ereignissen neu berechnet, die eine API verändern — ein Öffnen der Datei, ein Import, eine API-Aktualisierung — nicht bei jedem Tastendruck.