Salta al contenuto principale

Specifica OpenAPI / Swagger

Come utilizzare OpenAPI Validator

Fornisci la specifica

Incolla lo spec OpenAPI 3.x o Swagger 2.x in formato JSON nella textarea, oppure carica un file .json/.yaml/.yml, oppure premi "Carica esempio" per partire da uno spec valido di riferimento.

Avvia la validazione

Premi "Valida OpenAPI" per eseguire il controllo strutturale: campi obbligatori, operazioni, risposte e riferimenti $ref.

Leggi il riepilogo

Nella sidebar trovi formato rilevato (OpenAPI/Swagger), titolo, versione, numero di path, operazioni, schemi e tag, oltre al verdetto complessivo (valido, con errori o solo avvisi).

Filtra e correggi i problemi

Usa i contatori "Errori", "Avvisi" e "Info" per filtrare l'elenco dei problemi trovati e correggere la spec riga per riga.

Suggerimenti

  • Usa "Carica esempio" per vedere subito uno spec OpenAPI 3.0.3 valido e capire la struttura attesa.
  • Correggi prima tutti gli errori critici (bloccanti per generare SDK/documentazione), poi passa ai warning per migliorare la qualità dello spec.
  • Ogni "$ref" deve puntare a uno schema realmente definito nello stesso documento: se generi lo spec con OpenAPI Spec Generator, valida sempre il risultato qui prima di pubblicarlo.

Domande frequenti

Quali standard supporta il validatore?

OpenAPI 3.x (rilevato dal campo "openapi") e Swagger 2.x (rilevato dal campo "swagger"), entrambi in formato JSON. Il tool riconosce automaticamente quale dei due stai usando.

Che tipo di errori critici individua?

Campi obbligatori mancanti ("openapi"/"swagger", "info.title", "info.version", "paths"), path senza "/" iniziale, operazioni senza metodo HTTP, risposte assenti e riferimenti "$ref" che non puntano a uno schema definito in components/schemas o definitions.

Cosa sono invece gli avvisi (warning)?

Sono suggerimenti di best practice non bloccanti: mancanza di "info.description", "operationId", "summary"/"description" sull'operazione, "servers" (OpenAPI 3) o "host" (Swagger 2), e description mancante sulle singole risposte.

Posso caricare un file YAML?

L'upload accetta estensioni .json, .yaml e .yml, ma il parser di validazione elabora solo JSON: se carichi un file YAML puro (non JSON) la validazione segnalerà un errore di parsing. Converti prima il file in JSON per validarlo correttamente.

I dati incollati o caricati vengono inviati a un server?

No. La validazione è pura logica TypeScript eseguita nel browser, senza dipendenze npm esterne e senza alcuna chiamata di rete: lo spec resta sul tuo dispositivo.