我刚刚开始研究 ASP.NET 5。我想为我的方法提供一个帮助页面,我见过的创建帮助页面的示例很少,但大多数都是特定于 MVC 的。我经历过Microsoft.AspNet.WebApi.HelpPage
包,它为帮助页面创建了一个区域,但我没有使用 MVC 模式。
任何建议如何创建除此区域方法之外的帮助页面?
最佳答案
我建议看 Swagger和 SwaggerUI . Swagger 是一个开放标准,使用 JSON 来记录 API,由 PayPal 和 Microsoft 等公司使用(查看 azure 门户中的 Logic apps)。
.Net 有一些开源实现(我都使用过),它们会自我记录你的 API,只需将 NuGet 包添加到你的项目中并进行一些配置:
Swashbuckle 是原始项目,Ahoy 是针对 ASPNET5 的新版本。从 NuGet 下载包时,您仍将获得 Swashbuckle,只需确保勾选“包含预发布”,如果需要任何文档,请查看原始 GitHub 项目。
SwaggerUI(也包含在 Swashbuckle 中)添加了一个可用于导航和测试 API 的界面,默认情况下,当您的项目运行时,该界面可从“/swagger/ui”获得。
这是我放在 GitHub 中的示例存储库,展示了如何使用它:https://github.com/mattridgway/ASPNET5-SwaggerUI
关于asp.net-web-api - ASP .NET 5 WEB API 创建帮助页面,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/34015701/