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

时间:2015-12-01 08:22:01

标签: asp.net-web-api asp.net-core asp.net-web-api-helppages

我刚开始使用ASP.NET 5.我想为我的方法提供一个帮助页面,我已经看到了创建帮助页面的几个例子,但大多数都是MVC特定的。我已经通过Microsoft.AspNet.WebApi.HelpPage包,它创建了一个帮助页面区域,但我没有使用MVC模式。

任何建议如何创建除此区域方法之外的帮助页面?

1 个答案:

答案 0 :(得分:5)

我建议您查看SwaggerSwaggerUI。 Swagger是一个开放标准,使用JSON来记录API,由PayPal和Microsoft等人使用(在天蓝色门户网站中查看Logic apps)。

.Net有一些开源实现(我都使用过),它们会自动记录你的API,只需将NuGet包添加到你的项目中并进行一些配置:

Swashbuckle是原始项目,而Ahoy是面向ASPNET5的新版本。从NuGet下载软件包时,您仍然可以获得Swashbuckle,只需确保勾选"包括预发布",如果您需要任何文档,请查看原始的GitHub项目。

SwaggerUI(也包含在Swashbuckle中)添加了一个界面,您可以使用该界面来导航和测试您的API,默认情况下可以从" / swagger / ui"当你的项目正在运行时。

以下是GitHub中的一个样本仓库,我将它放在一起展示如何使用它:https://github.com/mattridgway/ASPNET5-SwaggerUI