Auto Genera documentazione per ASP.net WebAPI

Question

Attualmente ho un progetto MVC in ASP.Net che utilizza un WebApi. La maggior parte del codice per i controller è scritto in C#. Mi piacerebbe per generare automaticamente una descrizione di chiamate API tra cui:

1.) L'URL della pagina/endpoint

2.) Descrizione di ciò che endpoint/pagina non

3.) Elenco di argomenti con descrizioni e tipi di dati.

4.) HTTP Verbo (get, post, mettere, cancellare)

5.) Le autorizzazioni necessarie per la pagina

La descrizione dovrà essere scritto manualmente.

Ho letto molti altri articoli che portano all'individuo che utilizza un'applicazione di terze parti come Swagger. C'è qualcosa di integrato in ASP.Net per aiutare con questo? Se volessi provare a generare la documentazione da solo (senza utilizzare software di terze parti), come iniziare a creare tale documentazione?

Ho passato un bel po 'di tempo a cercare su Google varie domande e non riesco a trovare una risposta.

Modifica: Qual è il vantaggio di utilizzare Swagger su pagine di aiuto ASP.Net nel mio caso?

Answer 1

In alternativa a Swagger è possibile utilizzare lo 'Help Pages' per l'API Web ASP.NET.

voci all'interno di questa documentazione vengono generati automaticamente e conterrà le informazioni come ad esempio:

• URI relativo

• metodo HTTP dati

• Campione/Response

• A descrizione dello scopo dell'API (derivato dai commenti XML)

Se si utilizza un componente di terze parti è possibile, allora vi consiglio di usare Swagger (Utilizzare il Swashbuckle NuGet package) per ottenere la documentazione API.

Answer 2

Swagger non si limita a elencare l'api uris. Gli utenti li provano e vedono la risposta

Swagger dispone di strumenti per creare la documentazione prima di implementarla.

Può anche aggiungere una descrizione utilizzando i commenti.