Upptäcka problem i ett importerat API

När du importerar ett API (OpenAPI, Swagger och de andra formaten som stöds) behåller Restorm API:ets strukturerade dokumentation i dess variabelmapp. Direkt efter importen — och varje gång du öppnar filen igen — projicerar Restorm diskret den dokumentationen till en design och kör samma validering som API-designern tillämpar, helt i bakgrunden. Det blockerar aldrig importen och rör aldrig det du håller på med.

Om det inte hittar något ser du ingenting. Om det hittar strukturella problem pekar det ut dem för dig på två ställen.

”!” i sidofältet

Variabelmappen som bär det flaggade API:et visar ett litet ”!” till höger om sin rad. Det är signalen som med en blick säger att det här API:ets design har något värt att titta på — och den försvinner av sig själv när API:et är rent igen (efter en omimport eller en API-uppdatering som åtgärdar det).

Fliken ”Problem”

Öppna variabelmappen så får den en Problem-flik. Fliken visas bara när problem har upptäckts — ett rent API visar den aldrig.

Problem-fliken i ett importerat API variabelmapp: en varningsruta, sedan problemen grupperade efter typ — ”Flera vägar svarar på samma metod och sökväg”, ”Vissa vägar deklarerar inget svar”, ”Vissa vägar ligger på en sökväg som designservern reserverar” — var och en listar exakt vilka vägar den påverkar, en utfälld för att visa den vägens dokumentation

Problemen grupperas efter typ, så tjugo dubblerade vägar visas som en rad med en räknare i stället för tjugo separata poster. Under varje typ listar Restorm de exakta enheter som berörs — en väg visar sitt HTTP-verb och sin verkliga sökväg och fälls ut till den vägens dokumentation så att du kan se vad den deklarerar utan att lämna fliken.

Kontrollerna speglar API-designerns, så de sorters problem du kan se inkluderar:

dubblerade vägar — två vägar som svarar på samma metod och sökväg;
saknade svar — en väg som inte deklarerar något svar alls;
reserverade sökvägar — en väg som ligger på en sökväg som mockservern reserverar (/swagger.json, /graphql, …), som aldrig skulle svara;
villkorsproblem — ett ogiltigt mönster, eller ett minimum högre än sitt maximum.

Listan är skrivskyddad: den talar om vad du ska åtgärda, och du åtgärdar det vid källan (importera om en korrigerad specifikation, eller redigera API:et). Den räknas om vid de händelser som ändrar ett API — en filöppning, en import, en API-uppdatering — inte vid varje tangenttryckning.