我刚开始使用 ASP.NET 5。我想为我的方法创建一个帮助页面，我看到了一些创建帮助页面的示例，但其中大多数都是特定于 MVC 的。我已经浏览了Microsoft.AspNet.WebApi.HelpPage包，它为帮助页面创建了一个区域，但我没有使用 MVC 模式。
除此区域方法外，我如何创建帮助页面有什么建议吗？
问问题
1592 次
1 回答
5
我建议看看Swagger和SwaggerUI。Swagger 是一种开放标准，使用 JSON 来记录 API，被 PayPal 和 Microsoft 等公司使用（查看azure 门户中的Logic 应用程序）。
有一些 .Net 的开源实现（我都使用过），只需将 NuGet 包添加到您的项目并进行一些配置，它们就会自行记录您的 API：
Swashbuckle 是原始项目，Ahoy 是针对 ASPNET5 的新版本。从 NuGet 下载包时，您仍然会得到 Swashbuckle，只需确保勾选“包含预发布”，如果您需要任何文档，请查看原始 GitHub 项目。
SwaggerUI（也包含在 Swashbuckle 中）添加了一个界面，您可以使用它来导航和测试您的 API，默认情况下，当您的项目运行时，它可以从“/swagger/ui”获得。
这是 GitHub 中的一个示例存储库，我放在一起展示了它的使用方法：https ://github.com/mattridgway/ASPNET5-SwaggerUI
于 2016-02-08T22:06:44.890 回答