Download to read offline
![NET03
Swagger <3 WebAPI
Nicolò Carandini [MVP]
n.carandini@outlook.com
@TPCWare](https://image.slidesharecdn.com/swaggerloveswebapi-170704083458/75/Swagger-loves-webapi-2-2048.jpg)
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
- 4.
- 5. Internet Frontend BackendINTERNET Response body WebBrowser 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.
- 7.
- 8. Il problema Ma losai che senza la documentazione non possiamo fare nulla?
- 9. Ma no, nonc’è problema. Faccio un po’ di prove con Fiddler e scopro subito quali dati richiede!
- 10. La documentazione dell’API Inizialmenteviene fatta poi diventa incompleta e alla fine è inutilizzabile
- 11.
- 12. SWAGGER TO THERESCUE !
- 13.
- 14. •E’ una specificaOpen 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 diSwagger 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 tramiteNuGet Package. • Genera automaticamente il documento Swagger. • Contiene al suo interno Swagger.UI. • Genera lo schema dei dati direttamente dal codice.
- 17.
- 18.
- 19. Con i toolbasati su Swagger possiamo generare la documentazione in modo automatico partendo dal codice. Swagger è la soluzione
- 20.
- 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 documentazioneXML del codice 1. Abilitare la generazione della documentazione XML 2. Abilitare l’uso della documentazione XML in Swagger UI:
- 23.
- 24.
- 25.
- 26.
- 27.
- 28. Tutte le operazionieseguibili in Azure sono esposte tramite REST API. Microsoft usa Swagger per generare in automatico gli SDK di Azure. Azure SDK
- 29. Logic Apps Microsoft usaSwagger per generare in automatico la User Interface dell’editor.
- 30.