Repository files navigation

💡 Questo repository contiene un checker in-browser che verifica alcune delle regole per le API REST indicate nel Modello di Interoperabilità.

🗂️ I progetti associati sono indicati nell'API Starter Kit.

👨🏻‍💻 L'applicazione on-line pronta all'uso è disponibilequi.

Il modo più semplice per controllare un'API è di utilizzare questo checker, inserendo il contenuto dell'API e selezionando un set di regole (di default:Italian Guidelines Full). Cliccando su "Check" sarà possibile esaminare tutti gli errori, warning, info e hint rilevati da Spectral.

📌Per la pubblicazione di una API sul Catalogo PDND, eseguire l'OAS Checker con il profiloItalian Guidelines Full e verificare che loyaml presenti0 errori ed auspicabilmente0 warnings.

In alternativa, è possibile fare il check delle API tramite IDE, CLI e GitHub Action: si rimanda al seguenteREADME del repoapi-oas-checker-rules per tutte le informazioni.

Le regole che il checker utilizzata sono gestite in un repository dedicato:api-oas-checker-rules.

Al momento, i ruleset sono:

• spectral.yml, oItalian Guidelines Full, quelle di default
• spectral-generic.yml, oBest Practices Only
• spectral-security.yml, oExtra Security Checks
• spectral-full.yml, oItalian Guidelines Full + Extra Security Checks

Questa web app è basata sulla libreria React e usa Webpack per generare il bundle dell'applicazione con il supporto di Babel per transpilare il codice JavaScript.

Per avviare l'applicazione:

$ yarn$ yarn start

In alternativa:

$ docker-compose up --build start

e al termine della compilazione collegarsi ahttp://localhost:3000

Grazie a Paolo Falomo,Francesco Marinucci,Giuseppe De Marco,Andrea Misuraca,Simone Esposito,Rocco Affinitoe Vincenzo Chianese per i suggerimenti ed i contributi!

⚙️ Il checker è basato suSpectral.

Perché Spectral? 🤔

Lo abbiamo preferito rispetto ad altri software perchénon richiede l'utilizzo di database o componenti server a cui inviare i tuoi documenti OpenAPI (OAS Checker è una pagina statica deployata su GitHub Pages) e perché la maggior parte delle regole è descritta tramite file statici (e.g. YAML):tranne in casi specifici (es. set di regole per la security), non è necessario quindi eseguire codice JavaScript. Inoltre, gli utenti possono sempre limitarsi ad importare le sole regole statiche.

Le alternative valutate, ugualmente valide, sono:

• Zally ha bisogno di un database e non è possibile farne un webpackage;
• Speccy pare supportare solo regole in JavaScript, mentre questo checker utilizza per lo più dei file YAML statici.