Otkrivanje problema u uvezenom API-ju

Kada uvezete API (OpenAPI, Swagger i ostale podržane formate), Restorm čuva strukturiranu dokumentaciju API-ja u njegovoj fascikli promenljivih. Odmah nakon uvoza — i svaki put kada ponovo otvorite datoteku — Restorm neprimetno projektuje tu dokumentaciju u dizajn i pokreće istu validaciju koju primenjuje dizajner API-ja, u potpunosti u pozadini. Nikada ne blokira uvoz i nikada ne dira ono što radite.

Ako ne pronađe ništa, ne vidite ništa. Ako pronađe strukturne probleme, ukazuje vam na njih na dva mesta.

„!” u bočnoj traci

Fascikla promenljivih koja nosi označeni API prikazuje mali „!” sa desne strane svog reda. To je signal na prvi pogled da dizajn ovog API-ja ima nešto što zaslužuje pažnju — i nestaje sam od sebe čim API ponovo postane ispravan (nakon ponovnog uvoza ili ažuriranja API-ja koje ga ispravlja).

Kartica „Problemi”

Otvorite fasciklu promenljivih i ona dobija karticu Problemi. Kartica se pojavljuje samo kada su otkriveni problemi — ispravan API je nikada ne prikazuje.

Kartica Problemi fascikle promenljivih uvezenog API-ja: okvir sa upozorenjem, zatim problemi grupisani po tipu — „Više ruta odgovara na istu metodu i putanju", „Neke rute ne deklarišu nijedan odgovor", „Neke rute se nalaze na putanji koju rezerviše server dizajna" — svaki navodi tačne rute na koje utiče, jedna proširena da prikaže dokumentaciju te rute

Problemi su grupisani po tipu, tako da dvadeset dupliranih ruta izgleda kao jedan red sa brojačem umesto dvadeset zasebnih stavki. Ispod svakog tipa, Restorm navodi tačne obuhvaćene entitete — ruta prikazuje svoj HTTP glagol i stvarnu putanju i proširuje se do dokumentacije te rute kako biste mogli da vidite šta deklariše bez napuštanja kartice.

Provere odražavaju one dizajnera API-ja, pa vrste problema koje možete videti uključuju:

duplirane rute — dve rute koje odgovaraju na istu metodu i putanju;
nedostajući odgovori — ruta koja ne deklariše nijedan odgovor;
rezervisane putanje — ruta koja se nalazi na putanji koju Mock Server rezerviše (/swagger.json, /graphql, …), koja nikada ne bi odgovorila;
problemi sa ograničenjima — nevažeći obrazac ili minimum veći od svog maksimuma.

Lista je samo za čitanje: govori vam šta treba ispraviti, a vi to ispravljate na izvoru (ponovo uvezite ispravljenu specifikaciju ili izmenite API). Ponovo se izračunava na događajima koji menjaju API — otvaranje datoteke, uvoz, ažuriranje API-ja — a ne na svaki pritisak tastera.