Tovább a tartalomhoz
Restorm Restorm dokumentáció

Problémák felderítése egy importált API-ban

Amikor importál egy API-t (OpenAPI, Swagger és a többi támogatott formátum), a Restorm az API strukturált dokumentációját a változómappájában őrzi meg. Közvetlenül az importálás után — és minden alkalommal, amikor újra megnyitja a fájlt — a Restorm észrevétlenül tervvé vetíti ezt a dokumentációt, és ugyanazt az érvényesítést futtatja le, mint az API-tervező, teljes egészében a háttérben. Soha nem blokkolja az importálást, és soha nem szakítja meg azt, amin éppen dolgozik.

Ha nem talál semmit, Ön sem lát semmit. Ha strukturális problémákat talál, két helyen mutat rájuk.

A „!“ az oldalsávban

Section titled “A „!“ az oldalsávban”

A megjelölt API-t hordozó változómappa egy kis „!“ jelet mutat a sorának jobb oldalán. Ez az egy pillantással látható jelzés, hogy ennek az API-nak a terve valami figyelemre méltót rejt — és magától eltűnik, amint az API ismét hibátlan (egy újraimportálás vagy egy azt javító API-frissítés után).

A „Problémák“ lap

Section titled “A „Problémák“ lap”

Nyissa meg a változómappát, és megjelenik rajta egy „Problémák“ lap. A lap csak akkor jelenik meg, ha problémákat észlelt — egy hibátlan API sosem mutatja.

Egy importált API változómappájának „Problémák“ lapja: egy figyelmeztetés, majd a típus szerint csoportosított problémák — „Több útvonal ugyanarra a metódusra és elérési útra válaszol“, „Egyes útvonalak nem deklarálnak választ“, „Egyes útvonalak olyan elérési úton helyezkednek el, amelyet a tervezőszerver fenntart“ — mindegyik felsorolja a pontosan érintett útvonalakat, egy kibontva, hogy megmutassa az adott útvonal dokumentációját

A problémák típus szerint vannak csoportosítva, így húsz duplikált útvonal egyetlen sorként jelenik meg egy számlálóval húsz külön bejegyzés helyett. Minden típus alatt a Restorm felsorolja a pontosan érintett entitásokat — egy útvonal megmutatja a HTTP-igéjét és a valódi elérési útját, és kibomlik az adott útvonal dokumentációjára, így láthatja, mit deklarál anélkül, hogy elhagyná a lapot.

Az ellenőrzések az API-tervezőéit tükrözik, így a lehetséges problémák típusai közé tartoznak:

  • duplikált útvonalak — két útvonal, amely ugyanarra a metódusra és elérési útra válaszol;
  • hiányzó válaszok — egy útvonal, amely egyáltalán nem deklarál választ;
  • fenntartott elérési utak — egy útvonal, amely olyan elérési úton helyezkedik el, amelyet a Mock Server fenntart (/swagger.json, /graphql, …), és amely soha nem válaszolna;
  • megszorítási problémák — érvénytelen minta, vagy a maximumánál nagyobb minimum.

A lista csak olvasható: megmondja, mit kell javítani, Ön pedig a forrásnál javítja (importáljon újra egy javított specifikációt, vagy szerkessze az API-t). Az API-t megváltoztató eseményekkor számítódik újra — fájlmegnyitáskor, importáláskor, API-frissítéskor —, nem pedig minden billentyűleütéskor.