ASP .NET 5 WEB API 创建帮助页面答案

【问题标题】：ASP .NET 5 WEB API creating help pageASP .NET 5 WEB API 创建帮助页面
【发布时间】：2016-02-09 06:57:13
【问题描述】：

我刚开始使用 ASP.NET 5。我想为我的方法创建一个帮助页面，我看到的创建帮助页面的示例很少，但其中大多数都是特定于 MVC 的。我已经浏览了Microsoft.AspNet.WebApi.HelpPage 包，它创建了一个帮助页面区域，但我没有使用 MVC 模式。

除此区域方法外，我如何创建帮助页面有什么建议吗？

【问题讨论】：

【解决方案1】：

我建议查看Swagger 和SwaggerUI。 Swagger 是一种开放标准，使用 JSON 来记录 API，被 PayPal 和 Microsoft 等公司使用（在 azure 门户中查看 Logic apps）。

有一些 .Net 的开源实现（我都使用过），只需将 NuGet 包添加到您的项目并进行一些配置，它们就会自行记录您的 API：

Swashbuckle 是原始项目，Ahoy 是针对 ASPNET5 的新版本。从 NuGet 下载包时，您仍然会得到 Swashbuckle，只需确保勾选“包含预发布”，如果您需要任何文档，请查看原始 GitHub 项目。

SwaggerUI（也包含在 Swashbuckle 中）添加了一个界面，您可以使用该界面导航和测试您的 API，默认情况下，当您的项目运行时，该界面可从“/swagger/ui”获得。

这是我在 GitHub 中整理的一个示例 repo，展示了它的使用方法：https://github.com/mattridgway/ASPNET5-SwaggerUI

【讨论】：

虽然 Swagger 很了不起，但如果没有太多的适应工作，它就无法与 WebAPI 的自定义一起工作，而且遗憾的是，并不是所有的东西都可以在那里适应。 WebAPI 的提供程序是完全可定制的，因此这并不能完全替代 HelpPage 包。