2015-02-07 23 views
10

Attualmente sto verificando asp.net vnext MVC6 in Visual Studio 2015 Preview. Sono abbastanza nuovo per asp.net in generale, ma all'interno della mia azienda ci sposteremo verso la creazione di un API web usando asp.net per accedere ai dati sul nostro server (al momento supportiamo solo la comunicazione wcf con la nostra applicazione Silverlight). Questo è il motivo per cui sto verificando le nuove funzionalità di MVC 6 per giudicare se dovremmo aspettare prima di iniziare il nostro sviluppo e usare MVC 6 quando è finalmente rilasciato o avviare lo sviluppo ora e creare un progetto Web API 2.HelpPage per ASP.NET vNext MVC 6 Web Api

In ogni caso, sto cercando di documentare automaticamente l'API web, che è già integrata nel modello Visual Studio per un progetto WebApi 2 mediante Microsoft.AspNet.WebApi.HelpPage.

Ora per la mia domanda, qualcosa di simile è disponibile anche per MVC 6? Posso importare lo stesso pacchetto nel mio project.json nel mio progetto ASP.NET vNext/MVC6 (qualunque cosa tu voglia chiamarlo) ma non posso fare app.UseHelpPage(); nel mio file Startup.cs.

Sospetto che non sia ancora (ancora) integrato nella versione attuale. In caso contrario, c'è qualcosa di noto sull'integrazione di questa funzionalità una volta che ASP.NET vNext raggiunge gli scaffali?

risposta

4

Probabilmente questa funzione non è ancora disponibile in MVC 6, ma è possibile provare Swagger. Swagger è fondamentalmente un framework per la descrizione, il consumo e la visualizzazione di API RESTful. La cosa bella di Swashbuckle è che non ha dipendenza da ASP.NET MVC, quindi non c'è bisogno di includere alcun pacchetto MVC Nuget per abilitare la documentazione API, così come Swashbuckle contiene una versione incorporata di swagger-ui che servirà automaticamente una volta installato Swashbuckle.

Fonte: http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/

+0

Grazie per la punta, terrò a mente! Così com'è ora, però, non funziona con MVC 6. Penso che questo debba essere fatto perché e il progetto MVC 6 è un .kproj invece di un .csproj, il pacchetto nuget per Swashbuckle dà un errore quando installato. – Maarten

+0

C'è un modo per farlo funzionare in ASP.NET v6: http://devmeetsbi.ghost.io/help-and-test-page-for-asp-net-web-api-asp-net-5-and -mvc-6/ –

+0

Se la tua API non è riposante, però non funziona bene. Non direi che questa è una risposta valida in quanto solo parzialmente ti aiuterà. Quando usi i comandi personalizzati o l'associazione modello/azione, o se non stai creando un REST ma un'API basata su RPC, questo non funzionerà in quanto Swagger è molto stimato. –

Problemi correlati