Rilevare problemi in un'API importata

Quando importa un’API (OpenAPI, Swagger e gli altri formati supportati), Restorm conserva la documentazione strutturata dell’API sulla sua cartella di variabili. Subito dopo l’importazione — e ogni volta che riapre il file — Restorm proietta silenziosamente quella documentazione in un design ed esegue la stessa validazione applicata dal designer di API, interamente in background. Non blocca mai l’importazione e non interferisce mai con ciò che sta facendo.

Se non trova nulla, non vede nulla. Se trova problemi strutturali, glieli segnala in due punti.

Il «!» nella barra laterale

La cartella di variabili che contiene l’API segnalata mostra un piccolo «!» a destra della sua riga. È il segnale a colpo d’occhio che il design di questa API ha qualcosa che merita attenzione — e scompare da solo non appena l’API torna pulita (dopo una nuova importazione o un aggiornamento dell’API che la corregge).

La scheda «Problemi»

Apra la cartella di variabili e vi comparirà una scheda Problemi. La scheda appare solo quando vengono rilevati problemi — un’API pulita non la mostra mai.

La scheda Problemi della cartella di variabili di un'API importata: un avviso, poi i problemi raggruppati per tipo — «Diverse rotte rispondono allo stesso metodo e percorso», «Alcune rotte non dichiarano alcuna risposta», «Alcune rotte si trovano su un percorso riservato dal server di design» — ciascuno elenca le rotte esatte interessate, una espansa per mostrare la documentazione di quella rotta

I problemi sono raggruppati per tipo, così venti rotte duplicate si leggono come una sola riga con un conteggio anziché venti voci separate. Sotto ogni tipo, Restorm elenca le entità esatte interessate — una rotta mostra il suo verbo HTTP e il percorso reale, e si espande fino alla documentazione di quella rotta in modo da poter vedere ciò che dichiara senza lasciare la scheda.

I controlli rispecchiano quelli del designer di API, quindi i tipi di problemi che potrebbe vedere includono:

rotte duplicate — due rotte che rispondono allo stesso metodo e percorso;
risposte mancanti — una rotta che non dichiara alcuna risposta;
percorsi riservati — una rotta che si trova su un percorso riservato dal Mock Server (/swagger.json, /graphql, …), che non risponderebbe mai;
problemi di vincolo — un pattern non valido, o un minimo superiore al suo massimo.

L’elenco è di sola lettura: le dice cosa correggere, e lei lo corregge alla fonte (reimporti una specifica corretta, o modifichi l’API). Viene ricalcolato in occasione degli eventi che modificano un’API — l’apertura di un file, un’importazione, un aggiornamento dell’API — non a ogni battitura.