Gratuito, nel browser
Visualizzatore OpenAPI e Swagger
Carica o incolla il file OpenAPI (Swagger) di un'API, in JSON o YAML: la vedi ordinata, controllo se è scritta bene e puoi provare le chiamate.
Non hai un file sotto mano? (Swagger Petstore, l'API di prova ufficiale)
Il file non lascia il dispositivo. Si legge qui nel browser: a questo sito non arriva nulla.
Domande frequenti
Che cos'è Swagger, o OpenAPI?
È un modo standard di descrivere un'API in un file JSON o YAML: gli indirizzi che si possono chiamare (per esempio GET /clienti/{id}), i parametri, i dati che si mandano e quelli che tornano, gli errori e l'autenticazione. Swagger è il nome storico (fino alla versione 2.0), OpenAPI quello di oggi (3.0 e 3.1). Da quel file si genera la documentazione che vedi qui sotto.
A cosa serve questo visualizzatore?
A leggere un'API senza aprire il codice: capire cosa espone un servizio, cosa chiede e cosa restituisce, e provarlo. Serve anche a controllare il file: segnalo gli errori che lo rendono non valido (riferimenti che non portano da nessuna parte, parametri del percorso non dichiarati, risposte mancanti) e gli avvisi.
Perché «Try it out» a volte non funziona?
La prova parte dal tuo browser, e il browser chiama un altro sito solo se quel sito lo permette (si chiama CORS). Molte API pubbliche lo permettono, altre no, e se l'API è sulla rete dell'ufficio deve essere raggiungibile dal tuo computer. Quando non va, sotto la prova trovi comunque il comando curl già pronto, da lanciare dal PC.
Il mio file resta privato?
Sì. Il file si legge nel tuo browser e non viene mandato a questo sito. Se lo apri da un indirizzo, il browser lo scarica direttamente da lì. Le prove con «Try it out» vanno solo al server dell'API.
Perché l'interfaccia è in inglese?
La parte che mostra l'API è Swagger UI, lo strumento ufficiale, che esiste solo in inglese. Riepilogo, controlli e spiegazioni sono in italiano.
Programmi usati
La documentazione dell'API la disegna Swagger UI 5.34 (Apache-2.0, licenza), ospitato su questo sito e non modificato; il YAML lo legge js-yaml (MIT, licenza). Per convertire altri file c'è il convertitore di file.