Attivazione dell’ help page per web API

Nell’esigenza di dover fare un integrazione tra la mia applicazione web e un app ios/android ho iniziato a scrivere le web API. Nella fretta di dover implementare le web API la documentazione sulle stesse scarseggiava quindi nel cercare un’alternativa veloce ho utilizzato Microsoft.AspNet.WebApi.HelpPage.

Web API HelpPage automaticamente genera la documentazione per le nostre API rendendola fruibile dal nostro sito. In questo modo chi dovrà implementare le nostre API potrà apprendere dalla documentazione come utilizzarle. Tutta la documentazione generata è pesonalizzabile nello stile e nei testi.

Di seguito gli step per aggiungere la HelpPage delle nostre API:

• selezionare il progetto delle web API;
• tasto destro “gestione pacchetti nuget”;
• ricercare e installare il pacchetto Microsoft.AspNet.WebApi.HelpPage;

Per ulteriori dettagli: https://blogs.msdn.microsoft.com/webdev/2012/11/08/enabling-asp-net-web-api-help-pages-for-asp-net-web-forms-applications/