ASP.NET 5 WEB API Hilfe erstellen Seite

Question

Ich habe gerade angefangen, an ASP.NET 5 zu arbeiten. Ich möchte eine Hilfeseite für meine Methoden haben, ich habe einige Beispiele zum Erstellen von Hilfeseiten gesehen, aber die meisten sind MVC-spezifisch . Ich bin durch Microsoft.AspNet.WebApi.HelpPage Paket gegangen, es erstellt einen Bereich für Hilfe-Seite, aber ich verwende kein MVC-Muster.

Irgendwelche Vorschläge, wie ich Hilfeseite außer diesem Bereichsansatz erstellen kann?

Answer 1

Ich würde vorschlagen, Blick auf Swagger und SwaggerUI. Swagger ist ein offener Standard, der JSON verwendet, um eine API zu dokumentieren, die von Leuten wie PayPal und Microsoft verwendet wird (siehe Logic apps im azurblauen Portal).

Es gibt einige Open-Source-Implementierungen für .NET (beide von denen ich verwendet habe), die sich von selbst, Ihre API dokumentieren, nur durch die Pakete zu einem Projekt NuGet hinzufügen und ein wenig Konfiguration:

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

Swashbuckle ist das ursprüngliche Projekt und Ahoy ist die neue Version Targeting ASPNET5. Wenn Sie das Paket von NuGet herunterladen, erhalten Sie immer noch Swashbuckle, stellen Sie sicher, dass Sie "include pre-release" ankreuzen, und wenn Sie irgendwelche Dokumentation benötigen, sehen Sie sich das ursprüngliche GitHub-Projekt an.

SwaggerUI (das auch in Swashbuckle enthalten ist) fügt eine Schnittstelle hinzu, mit der Sie Ihre API durchsuchen und testen können, standardmäßig ist dies unter "/ swagger/ui" verfügbar, wenn Ihr Projekt ausgeführt wird.

Hier ein Beispiel Repo in GitHub I zeigt zusammengestellt, wie es verwendet werden kann: https://github.com/mattridgway/ASPNET5-SwaggerUI