Przejdź do głównej zawartości
Restorm Dokumentacja Restorm

Wykrywanie problemów w zaimportowanym API

Gdy importuje Pan/Pani API (OpenAPI, Swagger i pozostałe obsługiwane formaty), Restorm przechowuje ustrukturyzowaną dokumentację tego API w jego folderze zmiennych. Zaraz po imporcie — i za każdym razem, gdy ponownie otwiera Pan/Pani plik — Restorm dyskretnie rzutuje tę dokumentację na projekt i uruchamia tę samą walidację, którą stosuje projektant API, w całości w tle. Nigdy nie blokuje importu ani nie narusza tego, nad czym Pan/Pani pracuje.

Jeśli niczego nie znajdzie, niczego Pan/Pani nie zobaczy. Jeśli znajdzie problemy strukturalne, wskaże je Panu/Pani w dwóch miejscach.

Znak „!” na pasku bocznym

Section titled “Znak „!” na pasku bocznym”

Folder zmiennych zawierający oznaczone API pokazuje mały „!” po prawej stronie swojego wiersza. To sygnał widoczny na pierwszy rzut oka, że projekt tego API zawiera coś wartego uwagi — i znika samoczynnie, gdy tylko API znów będzie poprawne (po ponownym imporcie lub aktualizacji API, która je naprawia).

Karta „Problemy”

Section titled “Karta „Problemy””

Proszę otworzyć folder zmiennych, a pojawi się w nim karta Problemy. Karta pojawia się tylko wtedy, gdy wykryto problemy — poprawne API nigdy jej nie pokazuje.

Karta Problemy folderu zmiennych zaimportowanego API: ostrzeżenie, a następnie problemy pogrupowane według typu — „Kilka tras odpowiada na tę samą metodę i ścieżkę”, „Niektóre trasy nie deklarują żadnej odpowiedzi”, „Niektóre trasy znajdują się na ścieżce zarezerwowanej przez serwer projektu” — każdy z nich wymienia dokładne trasy, których dotyczy, a jeden jest rozwinięty, aby pokazać dokumentację danej trasy

Problemy są pogrupowane według typu, dzięki czemu dwadzieścia zduplikowanych tras czyta się jako jeden wiersz z licznikiem, a nie jako dwadzieścia osobnych pozycji. Pod każdym typem Restorm wymienia dokładne encje, których to dotyczy — trasa pokazuje swój czasownik HTTP i rzeczywistą ścieżkę oraz rozwija się do dokumentacji tej trasy, dzięki czemu można zobaczyć, co deklaruje, bez opuszczania karty.

Kontrole odzwierciedlają kontrole projektanta API, więc rodzaje problemów, które można zobaczyć, obejmują:

  • zduplikowane trasy — dwie trasy odpowiadające na tę samą metodę i ścieżkę;
  • brakujące odpowiedzi — trasa, która w ogóle nie deklaruje odpowiedzi;
  • zarezerwowane ścieżki — trasa znajdująca się na ścieżce zarezerwowanej przez Mock Server (/swagger.json, /graphql, …), która nigdy by nie odpowiedziała;
  • problemy z ograniczeniami — nieprawidłowy wzorzec lub wartość minimalna większa od maksymalnej.

Lista jest tylko do odczytu: mówi, co należy naprawić, a naprawia się to u źródła (proszę ponownie zaimportować poprawioną specyfikację lub edytować API). Jest przeliczana ponownie przy zdarzeniach zmieniających API — otwarciu pliku, imporcie, aktualizacji API — a nie przy każdym naciśnięciu klawisza.