ASP.NET Core Web API automatische Hilfeseiten

Question

In früheren Versionen von ASP.NET, als ich Web Api 2 erstellt, Visual Studio automatisch automatische Generierung von Dokumentation für die API verdrahtet.

Es erklärt auch hier: http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

ich ein neues Projekt zu schreiben und ich habe beschlossen, es mit ASP.NET-Core zu tun, aber ich sehe nichts, ähnlich wie im vorherigen existierte Versionen, die die Dokumentation von der API erzeugt (Ich rate auch, dass es ein bisschen anders ist, da alle Controller nun von der gleichen Controller Klasse erben).

Aber gibt es eine Möglichkeit, Hilfedateien für ASP.NET Core APIs zu generieren?

Answer 1

Die Funktionalität, die Sie wollen, ist bei https://github.com/domaindrivendev/Swashbuckle

Der folgende Link ein Beispiel liefert, wie die Konfiguration und Verwendung gut gestalteten Dienstprogramm https://damienbod.com/2015/12/13/asp-net-5-mvc-6-api-documentation-using-swagger/

Answer 2

John Davidson einen guten Beitrag gemacht zeigt, wie Swagger Dokumentation zu erzeugen, - Das ist nützlich und großartig.

Aber wenn Sie ASP.Net MVC 5 halten wollen - Dokumentation Api Explorer, sollten Sie einen Blick auf diese ausgezeichnete Blog-Post haben:

https://andrewlock.net/introduction-to-the-apiexplorer-in-asp-net-core/