Find problemer i et importeret API

Når du importerer et API (OpenAPI, Swagger og de øvrige understøttede formater), gemmer Restorm API’ets strukturerede dokumentation på dets miljømappe. Lige efter importen — og hver gang du genåbner filen — projicerer Restorm i stilhed denne dokumentation over i et design og kører den samme validering, som API-designeren bruger, helt i baggrunden. Det blokerer aldrig importen og afbryder aldrig det, du er i gang med.

Finder den intet, ser du intet. Finder den strukturelle problemer, peger den dig hen på dem to steder.

„!“ i sidepanelet

Miljømappen, der bærer det markerede API, viser et lille „!“ til højre i sin række. Det er signalet, der med ét blik fortæller, at dette API’s design er værd at se nærmere på — og det forsvinder af sig selv, så snart API’et er rent igen (efter en ny import eller en API-opdatering, der retter det).

Fanen „Problemer“

Åbn miljømappen, og den får en fane „Problemer“. Fanen vises kun, når der blev fundet problemer — et rent API viser den aldrig.

Problemerne er grupperet efter type, så tyve dublerede ruter fremstår som én linje med et tal i stedet for tyve separate poster. Under hver type viser Restorm de præcise berørte entiteter — en rute viser sit HTTP-verbum og sin rigtige sti og folder ud til den rutes dokumentation, så du kan se, hvad den angiver, uden at forlade fanen.

Tjekkene svarer til API-designerens, så blandt de problemer, du kan støde på, er:

• dublerede ruter — to ruter, der svarer på samme metode og sti;
• manglende responser — en rute, der slet ikke angiver nogen respons;
• reserverede stier — en rute, der ligger på en sti, som mockserveren reserverer (/swagger.json, /graphql, …), og som aldrig ville svare;
• begrænsningsproblemer — et ugyldigt mønster eller et minimum, der er højere end sit maksimum.

Listen er skrivebeskyttet: den fortæller dig, hvad du skal rette, og du retter det ved kilden (importér en rettet specifikation igen, eller redigér API’et). Den genberegnes ved de hændelser, der ændrer et API — en filåbning, en import, en API-opdatering — ikke ved hvert tastetryk.