![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Header_Evidenza-1024x505.png\")
<\/p>\n<\/p>\n
In questo articolo vedremo come creare una semplice API Web<\/strong> utilizzando il framework ASP.NET Core<\/strong> ed implementando, successivamente, lo strumento Swagger<\/strong>.<\/p>\n Swagger<\/strong><\/a> \u00e8 un framework open source<\/strong> con al suo interno un vasto ecosistema di strumenti per aiutare gli sviluppatori a progettare<\/em>, costruire<\/em>, utilizzare<\/em> e documentare<\/em> servizi web RESTful<\/a><\/strong>. Per approfondire lo strumento, potete trovare ulteriori informazioni sul sito ufficiale<\/a> del progetto.<\/p>\n Per seguire questa guida avremo bisogno dei seguenti strumenti installati sul sistema che andremo ad utilizzare:<\/p>\n Apriamo Visual Studio<\/strong> ed iniziamo con le creazione di un nuovo progetto, quindi: File<\/strong>, Nuovo<\/strong>, Progetto…<\/strong>. Cerchiamo la tipologia di progetto “Applicazione Web ASP.NET Core<\/em>” e selezioniamo il relativo tipo di progetto:<\/p>\n Selezionare successivamente .NET Core<\/strong> ed API<\/strong>:<\/p>\n Al termine della creazione del progetto ci troveremo davanti ad una struttura file come la seguente:<\/p>\n Eseguendo il progetto otteniamo un file JSON<\/strong> contenente una lista di informazioni meteo di esempio:<\/p>\n Aggiungiamo ora una nuova classe modello che chiamiamo BookItem<\/strong>, all’interno di una nuova cartella Models<\/strong>:<\/p>\n Aggiungiamo successivamente un contesto database installando innanzitutto i componenti Microsoft.EntityFrameworkCore.SqlServer<\/strong> e Microsoft.EntityFrameworkCore.InMemory<\/strong>:<\/p>\n Aggiungiamo poi una classe ExampleContext<\/strong>, sempre all’interno della cartella Models<\/em> creata in precedenza:<\/p>\n Ora \u00e8 arrivato il momento di registrare il contesto database<\/strong> appena creato:<\/p>\n Ed aggiungere successivamente un elemento di scaffolding<\/em> per il modello BookItem<\/strong>:<\/p>\n Nota: ho sostituito “GetBookItem”<\/strong> con nameof(GetBookItem)<\/strong>, per avere la chiamata con la stesso nome della classe in caso di modifiche future.<\/em><\/span><\/p>\n A questo punto siamo pronti per eseguire l’API Web e testare la chiamata appena creata api\/BookItems<\/strong> che restituir\u00e0 un elenco di elementi BookItem<\/strong> presenti nella base dati. Nel nostro caso, non avendo inserito alcun elemento, il risultato ottenuto sar\u00e0 un vettore vuoto:<\/p>\n Terminato il progetto API Web, aggiungiamo ora lo strumento Swagger<\/strong> e per farlo, utilizziamo il componente Swashbuckle<\/strong>.<\/p>\n Installiamo quindi dal gestore pacchetti, il componente Swashbuckle.AspNetCore<\/strong>:<\/p>\n Aggiungiamo e registriamo il servizio all’interno del file classe Startup.cs<\/strong>:<\/p>\n All’interno del metodo ConfigureServices<\/strong>:<\/p>\n E all’interno del metodo Configure<\/strong>:<\/p>\n Eseguendo ora il progetto, all’indirizzo swagger\/index.html<\/strong>, verr\u00e0 caricato lo strumento appena configurato:<\/p>\n Come potete vedere, con questo strumento \u00e8 possibile avere una panoramica documentale delle API Web ed \u00e8 anche possibile effettuare operazioni (GET, POST, PUT, ecc…<\/em>) direttamente da interfaccia grafica.<\/p>\n Ecco un esempio:<\/p>\nChe cos’\u00e8 Swagger?<\/h3>\n
\nIl set di strumenti che Swagger mette a disposizione \u00e8 comprensivo della gestione automatizzata di: documentazione, generazione del codice di implementazione e generazione di casi d’uso di esempio per le API.<\/p>\nPrerequisiti<\/h3>\n
\n
Creazione del progetto<\/h3>\n
![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Diagramma.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Configura_Nuovo_Progetto-e1576061882375-1024x539.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Nuova_Applicazione_AspNetCore-e1576062149164.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Struttura_Progetto_Nuovo.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Risultato_Primo_Avvio-1024x101.png\")
<\/a><\/p>\n\r\n[\r\n {"date":"2019-11-27T14:43:20.8538682+01:00","temperatureC":52,"temperatureF":125,"summary":"Mild"},\r\n {"date":"2019-11-28T14:43:20.857579+01:00","temperatureC":41,"temperatureF":105,"summary":"Chilly"},\r\n {"date":"2019-11-29T14:43:20.8575837+01:00","temperatureC":5,"temperatureF":40,"summary":"Chilly"},\r\n {"date":"2019-11-30T14:43:20.8575842+01:00","temperatureC":41,"temperatureF":105,"summary":"Balmy"},\r\n {"date":"2019-12-01T14:43:20.8575846+01:00","temperatureC":3,"temperatureF":37,"summary":"Mild"}\r\n]\r\n<\/pre>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Classe_BookItem-e1576159404816.png\")
<\/a><\/p>\n\r\npublic class BookItem\r\n{\r\n public int Id { get; set; }\r\n public string ISBN { get; set; }\r\n public string Title { get; set; }\r\n public string Author { get; set; }\r\n public string Year { get; set; }\r\n public string Story { get; set; }\r\n}\r\n<\/pre>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/NPM_SqlServer-1024x238.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/NPM_InMemory-1024x218.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/DBContext-e1576159476405.png\")
<\/a><\/p>\n\r\npublic class ExampleContext : DbContext\r\n{\r\n public ExampleContext(DbContextOptions<ExampleContext> options) : base(optons)\r\n {\r\n }\r\n\r\n public DbSet<BookItem> TodoItems { get; set; }\r\n}\r\n<\/pre>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Registrazione_DbContext-e1576159525996.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Aggiunta_Elemento_Scaffolding_1.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Aggiunta_Elemento_Scaffolding_2-e1576159641457.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Aggiunta_Elemento_Scaffolding_3-e1576159685511.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Aggiunta_Elemento_Scaffolding_4.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Vettore_vuoto.png\")
<\/a><\/p>\nAggiunta di Swagger<\/h3>\n
![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/NPM_Swashbuckle-1024x244.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Registrazione_Swagger.png\")
<\/a><\/p>\n\r\nservices.AddSwaggerGen(c =>\r\n{\r\n c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });\r\n});\r\n<\/pre>\n\r\napp.UseSwagger();\r\n\r\napp.UseSwaggerUI(c =>\r\n{\r\n c.SwaggerEndpoint("\/swagger\/v1\/swagger.json", "My API V1");\r\n});\r\n<\/pre>\n![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Home_Swagger-1024x505.png\")
<\/a><\/p>\n
![\"\"](\"https:\/\/cloudsurfers.it\/wp-content\/uploads\/\/2019\/12\/Test_Swagger-1024x480.png\")
<\/a><\/p>\n