ASP.NET vNext MVC 6 Web Api 的帮助页面答案

【问题标题】：HelpPage for ASP.NET vNext MVC 6 Web ApiASP.NET vNext MVC 6 Web Api 的帮助页面
【发布时间】：2015-04-07 17:01:37
【问题描述】：

我目前正在 Visual Studio 2015 Preview 中查看 asp.net vnext MVC6。总的来说，我对 asp.net 还是很陌生，但在我的公司内部，我们将转向使用 asp.net 创建一个 web api 来访问我们服务器上的数据（目前我们只支持与我们自己的 silverlight 应用程序的 wcf 通信）。这就是我检查 MVC 6 的新功能的原因，以判断我们是应该在开始开发之前等待并在 MVC 6 最终发布时使用它，还是现在开始开发并创建一个 Web API 2 项目。

无论如何，我正在研究自动记录 web api，它已经通过使用 Microsoft.AspNet.WebApi.HelpPage 集成到 WebApi 2 项目的 Visual Studio 模板中。

现在我的问题是，这样的东西是否也适用于 MVC 6？我可以在我的 ASP.NET vNext / MVC6（无论你想怎么称呼它）项目中的 project.json 中导入相同的包，但我不能在我的 Startup.cs 文件中执行 app.UseHelpPage();。

我怀疑这还没有（还）集成到当前版本中。如果没有，一旦 ASP.NET vNext 最终上架，是否有任何关于此功能集成的信息？

【问题讨论】：

标签： asp.net asp.net-core-mvc

【解决方案1】：

这个功能可能在 MVC 6 中还没有，但你可以试试 Swagger。 Swagger 基本上是一个用于描述、使用和可视化 RESTful API 的框架。 Swashbuckle 的好处在于它不依赖于 ASP.NET MVC，因此无需包含任何 MVC Nuget 包即可启用 API 文档，而且 Swashbuckle 包含一个嵌入式版本的 swagger-ui，它会自动提供服务一旦安装了 Swashbuckle。

来源：http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/

【讨论】：

感谢您的提示，我会记住这一点！但就目前而言，它也不适用于 MVC 6。我认为这是必须的，因为 MVC 6 项目是 .kproj 而不是 .csproj，Swashbuckle 的 nuget 包在安装时会出错。跨度>
有一种方法可以让它在 ASP.NET v6 中工作：devmeetsbi.ghost.io/…
如果你的 API 不是安静的，那么这不是很好。我不会说这是一个有效的答案，因为它只会部分帮助你。当您使用自定义命令或模型/动作绑定时，或者如果您创建的不是 REST 而是更类似于 RPC 的 API，这将不起作用，因为 Swagger 非常固执己见。