HelpPage für ASP.NET vNext MVC 6 Web API

Ich überprüfe derzeit asp.net vnext MVC6 in Visual Studio 2015 Vorschau. Ich bin ziemlich neu bei asp.net im Allgemeinen, aber innerhalb meiner Firma werden wir in Richtung einer Web-API mit asp.net für den Zugriff auf Daten auf unserem Server (derzeit unterstützen wir nur die Kommunikation mit unserer eigenen eigenen silflight-Anwendung) bewegen. Dies ist der Grund, warum ich die neuen Funktionalitäten von MVC 6 überprüfe, um zu beurteilen, ob wir warten sollten, bevor wir unsere Entwicklung beginnen und MVC 6 verwenden, wenn es endlich veröffentlicht wird oder jetzt mit der Entwicklung beginnt und ein Web-API-2-Projekt erstellt.HelpPage für ASP.NET vNext MVC 6 Web API

Wie auch immer, ich bin in der Auto-Dokumentation der Web-API, die bereits in die Visual Studio-Vorlage für ein WebApi 2-Projekt durch Verwendung von Microsoft.AspNet.WebApi.HelpPage integriert ist.

Jetzt für meine Frage, ist so etwas für MVC 6 auch verfügbar? Ich kann das gleiche Paket in meiner project.json in meinem Projekt ASP.NET vNext/MVC6 (wie auch immer Sie es nennen möchten) importieren, aber ich kann app.UseHelpPage(); in meiner Startup.cs-Datei nicht tun.

Ich vermute, das ist (noch) nicht in der aktuellen Version noch integriert. Wenn nicht, ist etwas über die Integration dieses Features bekannt, sobald ASP.NET vNext schließlich in die Regale gelangt?

Quelle

2015-02-07 Maarten

Wahrscheinlich ist diese Funktion in MVC 6 noch nicht verfügbar, aber Sie könnten Swagger ausprobieren. Swagger ist im Grunde ein Framework zum Beschreiben, Verbrauchen und Visualisieren von REST-APIs. Das Schöne an Swashbuckle ist, dass es keine Abhängigkeit von ASP.NET MVC hat. Daher müssen keine MVC Nuget-Pakete hinzugefügt werden, um API-Dokumentation zu aktivieren. Swashbuckle enthält eine eingebettete Version von swagger-ui, die automatisch geliefert wird up sobald Swashbuckle installiert ist.

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

Quelle

2015-02-07 16:44:12

Danke für den Tipp, werde ich dies im Auge behalten! Wie es jetzt aussieht, funktioniert es auch nicht mit MVC 6. Ich denke, das hat zu tun, weil und MVC 6-Projekt ist ein .kproj anstelle von .csproj, das nugget-Paket für Swashbuckle gibt einen Fehler, wenn installiert. – Maarten

Es gibt eine Möglichkeit, dies in ASP.NET v6 zum Laufen zu bringen: http://devmeetsbi.ghost.io/help-and-test-page-for-asp-net-web-api-asp-net-5-and -mvc-6/ –

Wenn Ihre API nicht erholsam ist, funktioniert das nicht gut. Ich würde nicht sagen, dass dies eine gültige Antwort ist, da es Ihnen nur teilweise helfen wird. Wenn Sie benutzerdefinierte Befehle oder eine Modell-/Aktionsbindung verwenden oder wenn Sie keine REST, sondern eine RPC-ähnliche API erstellen, funktioniert dies nicht, da Swagger sehr eigensinnig ist. –

HelpPage für ASP.NET vNext MVC 6 Web API

Antwort

Verwandte Themen