ASP .NET 5 WEB API創建幫助頁面

我剛剛開始研究ASP.NET 5.我想爲我的方法提供一個幫助頁面，我看到幾個創建幫助頁面的例子，但其中大多數都是MVC特定的。我已經通過Microsoft.AspNet.WebApi.HelpPage包，它創建了一個幫助頁面的區域，但我沒有使用MVC模式。ASP .NET 5 WEB API創建幫助頁面

任何建議如何創建除此區域方法之外的幫助頁面？

來源

2015-12-01 user1586570

還有什麼需要，你可以在下面標記爲正確？我的回答 –

我會建議看看Swagger和SwaggerUI。 Swagger是一個開放標準，使用JSON來記錄一個API，由PayPal和Microsoft等使用（在azure門戶中檢出Logic apps）。

有對於.NET（兩者我都用過）一些開源實現，這將自我記錄您的API，只需通過添加的NuGet包到項目，並配置了一點點：

Swashbuckle是原來的項目和阿霍伊是新版本定位ASPNET5。從NuGet下載軟件包時，您仍然可以獲得Swashbuckle，只需確保您勾選「包含預發佈」，並且如果您需要任何文檔，請查看原始GitHub項目。

SwaggerUI（也包含在Swashbuckle中）增加了一個可用於導航和測試API的接口，默認情況下，當您的項目運行時，該接口可從「/ swagger/ui」獲得。

這裏是GitHub的一個樣本回購我放在一起展示它如何被使用：https://github.com/mattridgway/ASPNET5-SwaggerUI

來源

2016-02-08 22:06:44

儘管Swagger很出色，但它不適用於沒有太多適應性工作的WebAPI定製，也不是所有的東西都可以在那裏適應。 WebAPI的提供者完全可定製，因此這不提供HelpPage包的完整替換。 –

ASP .NET 5 WEB API創建幫助頁面

回答

相關問題