Dal nuovo ASP.NET and Web Tools 2012.2, il template di progetto ASP.NET Web API si è dotato di una funzionalità estremamente comoda: stiamo parlando di help page, ossia della possibilità di generare, in maniera del tutto automatica, delle guide online sui servizi che esponiamo. Ciò avviene grazie a un HelpController, situato nell'area HelpPage del progetto.
HelpController si occupa di produrre una documentazione HTML grazie all'oggetto ApiExplorer; questa pagina di help sarà accessibile dal percorso /help (che possiamo comunque personalizzare ridefinendo la route) e offrirà un valido aiuto agli sviluppatori che intendono impiegare la nostra API nel loro progetto client.
Per ogni risorsa disponibile nel progetto ASP.NET Web API, questa guida elenca tutti i metodi di tipo GET, POST, PUT e DELETE per l'esecuzione di operazioni CRUD, visualizzando testi descrittivi per le action e i loro parametri, oltre che fornire codice JSON o XML di esempio da fornire come payload della richiesta.
Documentare la nostra Web Api è quasi immediato: ci si può avvalere della documentazione XML in tre semplici passi, il primo dei quali consiste nell'annotare la action come nell'esempio in basso.
/// <summary> /// Aggiorna un prodotto esistente /// </summary> /// <param name="id">L'ID univoco del prodotto</param> /// <param name="product">Il prodotto da aggiornare</param> public void PutProduct(int Id, Product product) { //Codice per l'aggiornamento }
A questo punto, dovremo assicurarci, dalle proprietà del progetto, che alla compilazione venga prodotto un file XML di documentazione, sfruttando l'opzione in figura.
L'ultimo passaggio consiste nell'impostare il percorso dell'XML di documentazione nella classe di configurazione del provider HelpPageConfig.
config.SetDocumentationProvider(new XmlDocumentationProvider( HttpContext.Current.Server.MapPath("~/App_data/DocumentazioneWebApi.xml")));
Il risultato di questa operazione sarà simile a quello mostrato in figura.
Commenti
Per inserire un commento, devi avere un account.
Fai il login e torna a questa pagina, oppure registrati alla nostra community.
Approfondimenti
Sfruttare MQTT in cloud e in edge con Azure Event Grid
Utilizzare Model as a Service su Microsoft Azure
Sfruttare lo stream rendering per le pagine statiche di Blazor 8
Elencare le container images installate in un cluster di Kubernetes
Ottimizzare la latenza in Blazor 8 tramite InteractiveAuto render mode
Eseguire una GroupBy per entity in Entity Framework
Utilizzare Azure AI Studio per testare i modelli AI
Usare un KeyedService di default in ASP.NET Core 8
Personalizzare l'errore del rate limiting middleware in ASP.NET Core
Eseguire attività pianificate con Azure Container Jobs
Ottimizzazione dei block template in Angular 17
Usare le variabili per personalizzare gli stili CSS