ASP .NET 5 WEB API che crea la pagina di aiuto

Question

Ho appena iniziato a lavorare su ASP.NET 5. Voglio avere una pagina di aiuto per i miei metodi, ho visto alcuni esempi per la creazione di pagine di aiuto ma la maggior parte di essi sono specifici per MVC . Ho attraversato il pacchetto Microsoft.AspNet.WebApi.HelpPage, crea un'area per la pagina di aiuto, ma non utilizzo il pattern MVC.

Qualche suggerimento come posso creare una pagina di guida diversa da questa area?

Answer 1

Suggerisco di guardare Swagger e SwaggerUI. Swagger è uno standard aperto, che utilizza JSON per documentare un'API, utilizzata da PayPal e Microsoft (dai un'occhiata a Logic apps nel portale azzurro).

ci sono alcune implementazioni open source di .Net (entrambi i quali ho usato), che si auto documentare la vostra API, solo con l'aggiunta dei pacchetti Nuget al progetto e un po 'di configurazione:

• https://github.com/domaindrivendev/Swashbuckle
• https://github.com/domaindrivendev/Ahoy

Swashbuckle è il progetto originale e Ahoy è la nuova versione mira ASPNET5. Quando scarichi il pacchetto da NuGet, otterrai comunque Swashbuckle, assicurati di spuntare "include pre-release" e, se hai bisogno di documentazione, guarda al progetto originale di GitHub.

SwaggerUI (che è anche incluso nel Swashbuckle) aggiunge un'interfaccia che è possibile utilizzare per navigare e testare la vostra API, per impostazione predefinita questo è disponibile da "/ spavalderia/ui" quando il progetto è in esecuzione.

Ecco un repo campione in GitHub ho messo insieme mostrando come esso può essere utilizzato: https://github.com/mattridgway/ASPNET5-SwaggerUI