![NET03
Swagger <3 WebAPI
Nicolò Carandini [MVP]
n.carandini@outlook.com
@TPCWare](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)
Recommended
More Related Content
What's hot
Similar to Swagger loves WebAPI
Similar to Swagger loves WebAPI (20)
More from Nicolò Carandini
More from Nicolò Carandini (20)
Swagger loves WebAPI
- 2. NET03 Swagger <3 WebAPI Nicolò Carandini [MVP] n.carandini@outlook.com @TPCWare
- 3. •Dove e perché serve •Cos'è e come si usa •Demo •Casi d’uso Swagger
- 5. Internet Frontend BackendINTERNET Response body Web Browser ASP.NET MVC | SPA WebForms ASP.NET WebAPI Mobile Response body
- 6. Servizi REST Il Client • Usa i metodi HTTP per identificare l’azione (Get/Post/Put/Delete). • Usa l’URL per identificare la risorsa e passare eventuali parametri. • Usa il body per i dati inviati o ricevuti, di solito in XML o JSON. Il Servizio • Espone un insieme di azioni richiamabili dal client, ciascuna con i parametri e dati del body richiesti ed opzionali, chiamato API (Application Program Interface) del servizio.
- 8. Il problema Ma lo sai che senza la documentazione non possiamo fare nulla?
- 9. Ma no, non c’è problema. Faccio un po’ di prove con Fiddler e scopro subito quali dati richiede!
- 10. La documentazione dell’API Inizialmente viene fatta poi diventa incompleta e alla fine è inutilizzabile
- 12. SWAGGER TO THE RESCUE !
- 14. •E’ una specifica Open Source. •E’ lo standard di fatto per la descrizione delle RESTful API. •Usa un linguaggio JSON like per descrivere le azioni, i parametri e la struttura dei dati dell’API. Swagger
- 15. I Tool di Swagger L’utilità di Swagger risiede nei tool che usano la sua sintassi, come ad esempio: Swashbuckle • Produce il documento Swagger di una WebAPI ASP.NET Swagger.UI • Genera, a partire da un documento Swagger, un set di pagine html di documentazione delle API.
- 16. Swashbuckle • Fornito tramite NuGet Package. • Genera automaticamente il documento Swagger. • Contiene al suo interno Swagger.UI. • Genera lo schema dei dati direttamente dal codice.
- 17. Swagger UI
- 19. Con i tool basati su Swagger possiamo generare la documentazione in modo automatico partendo dal codice. Swagger è la soluzione
- 21. File di configurazione • Consente la personalizzazione della documentazione Swagger generata e della Swagger UI. • Utilizza e include automaticamente i commenti Xml del codice. • Supporta la descrizione degli schemi ApiKey, Basic Auth and OAuth2.
- 22. Includere la documentazione XML del codice 1. Abilitare la generazione della documentazione XML 2. Abilitare l’uso della documentazione XML in Swagger UI:
- 28. Tutte le operazioni eseguibili in Azure sono esposte tramite REST API. Microsoft usa Swagger per generare in automatico gli SDK di Azure. Azure SDK
- 29. Logic Apps Microsoft usa Swagger per generare in automatico la User Interface dell’editor.
Editor's Notes
- Swagger UI è un insieme di template HTML, codice Javascript e CSS che generano dinamicamente una documentazione dell’API fruibile da Web a partire da un documento Swagger.