use*_*570 6 asp.net-web-api asp.net-web-api-helppages asp.net-core
我刚开始研究ASP.NET 5.我想为我的方法提供一个帮助页面,我已经看到了创建帮助页面的几个例子,但大多数都是MVC特定的.我已经通过Microsoft.AspNet.WebApi.HelpPage包,它创建了一个帮助页面的区域,但我没有使用MVC模式.
任何建议如何创建除此区域方法之外的帮助页面？
我建议看看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
| 归档时间： |
|
| 查看次数： |
1548 次 |
| 最近记录： |