Detectarea problemelor într-un API importat

Când importați un API (OpenAPI, Swagger și celelalte formate acceptate), Restorm păstrează documentația structurată a API-ului pe folderul său de variabile. Imediat după import — și de fiecare dată când redeschideți fișierul — Restorm proiectează discret acea documentație într-un design și rulează aceeași validare pe care o aplică designerul de API, în întregime în fundal. Nu blochează niciodată importul și nu afectează niciodată ceea ce faceți.

Dacă nu găsește nimic, nu vedeți nimic. Dacă găsește probleme structurale, vi le indică în două locuri.

„!”-ul din bara laterală

Folderul de variabile care poartă API-ul semnalat afișează un mic „!” în partea dreaptă a rândului său. Este semnalul dintr-o privire că designul acestui API are ceva ce merită o atenție — și dispare de la sine odată ce API-ul este din nou curat (după o reimportare sau o actualizare a API-ului care îl remediază).

Fila „Probleme”

Deschideți folderul de variabile și acesta capătă o filă Probleme. Fila apare doar atunci când au fost detectate probleme — un API curat nu o afișează niciodată.

Fila Probleme a folderului de variabile al unui API importat: o casetă de avertizare, apoi problemele grupate pe tipuri — „Mai multe rute răspund la aceeași metodă și cale", „Unele rute nu declară niciun răspuns", „Unele rute se află pe o cale rezervată de serverul de design" — fiecare listând rutele exacte pe care le afectează, una extinsă pentru a arăta documentația acelei rute

Problemele sunt grupate pe tip, astfel încât douăzeci de rute duplicate apar ca o singură linie cu un contor, în loc de douăzeci de intrări separate. Sub fiecare tip, Restorm listează entitățile exacte vizate — o rută își arată verbul HTTP și calea reală și se extinde la documentația acelei rute, astfel încât să puteți vedea ce declară fără a părăsi fila.

Verificările le reflectă pe cele ale designerului de API, așa că tipurile de probleme pe care le puteți vedea includ:

rute duplicate — două rute care răspund la aceeași metodă și cale;
răspunsuri lipsă — o rută care nu declară niciun răspuns;
căi rezervate — o rută aflată pe o cale pe care Mock Server o rezervă (/swagger.json, /graphql, …), care nu ar răspunde niciodată;
probleme de constrângere — un tipar invalid sau un minim mai mare decât maximul său.

Lista este doar pentru citire: vă spune ce trebuie remediat, iar dumneavoastră remediați la sursă (reimportați o specificație corectată sau editați API-ul). Este recalculată la evenimentele care modifică un API — deschiderea unui fișier, un import, o actualizare a API-ului — nu la fiecare apăsare de tastă.