Oppdage problemer i et importert API

Når du importerer et API (OpenAPI, Swagger og de andre støttede formatene), beholder Restorm APIets strukturerte dokumentasjon på miljømappen dets. Rett etter importen — og hver gang du åpner filen på nytt — projiserer Restorm stille denne dokumentasjonen til et design og kjører den samme valideringen som API-designeren bruker, helt i bakgrunnen. Den blokkerer aldri importen og rører aldri det du holder på med.

Finner den ingenting, ser du ingenting. Finner den strukturelle problemer, peker den deg mot dem to steder.

«!»-et i sidepanelet

Miljømappen som bærer det flaggede APIet, viser en liten «!» til høyre i raden sin. Det er signalet ved første øyekast om at designet til dette APIet har noe verdt en titt — og det forsvinner av seg selv så snart APIet er rent igjen (etter en ny import eller en API-oppdatering som retter det).

«Problemer»-fanen

Åpne miljømappen, så får den en Problemer-fane. Fanen dukker bare opp når problemer ble oppdaget — et rent API viser den aldri.

Problemene er gruppert etter type, slik at tjue duplikatruter leses som én linje med et antall i stedet for tjue separate oppføringer. Under hver type lister Restorm opp de nøyaktige enhetene det gjelder — en rute viser HTTP-verbet og den faktiske stien sin, og utvider seg til dokumentasjonen til den ruten slik at du kan se hva den erklærer uten å forlate fanen.

Sjekkene speiler API-designerens, så typene problemer du kan se, omfatter blant annet:

• duplikatruter — to ruter som svarer på samme metode og sti;
• manglende responser — en rute som ikke erklærer noen respons i det hele tatt;
• reserverte stier — en rute som ligger på en sti som mockserveren reserverer (/swagger.json, /graphql, …), og som aldri ville svare;
• begrensningsproblemer — et ugyldig mønster, eller et minimum som er høyere enn maksimumet sitt.

Listen er skrivebeskyttet: den forteller deg hva du skal rette, og du retter det ved kilden (importer en korrigert spesifikasjon på nytt, eller rediger APIet). Den beregnes på nytt ved hendelsene som endrer et API — en filåpning, en import, en API-oppdatering — ikke ved hvert tastetrykk.