Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/asp.net-core/3.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Asp.net web api ASP.NET5WebAPI创建帮助页_Asp.net Web Api_Asp.net Core_Asp.net Web Api Helppages - Fatal编程技术网

Asp.net web api ASP.NET5WebAPI创建帮助页

Asp.net web api ASP.NET5WebAPI创建帮助页,asp.net-web-api,asp.net-core,asp.net-web-api-helppages,Asp.net Web Api,Asp.net Core,Asp.net Web Api Helppages,我刚开始使用ASP.NET5。我想为我的方法提供一个帮助页面,我已经看到了一些创建帮助页面的示例,但大多数都是MVC特有的。我已经通过了Microsoft.AspNet.WebApi.HelpPage的包,它为帮助页面创建了一个区域,但我没有使用MVC模式 除了此区域方法之外,我如何创建帮助页面有什么建议吗 我建议看一下和。Swagger是一种开放标准,使用JSON来记录API,PayPal和Microsoft等公司都使用它(请访问azure门户) 有一些.Net的开源实现(我都使用过这两种实现

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


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

我建议看一下和。Swagger是一种开放标准,使用JSON来记录API,PayPal和Microsoft等公司都使用它(请访问azure门户)

有一些.Net的开源实现(我都使用过这两种实现),只需将NuGet包添加到您的项目中并进行一点配置,就可以自行记录您的API:

Swashback是最初的项目,Ahoy是针对ASPNET5的新版本。从NuGet下载软件包时,您仍然会得到Swashback,只需确保勾选“include pre release”,如果需要任何文档,请查看原始GitHub项目

SwaggerUI(也包括在Swashback中)添加了一个界面,您可以使用该界面来导航和测试API,默认情况下,在项目运行时可从“/swagger/ui”获得该界面


下面是我在GitHub中制作的一个示例repo,展示了如何使用它:

您还需要什么吗,请您在下面将我的答案标记为正确吗?虽然Swagger令人惊讶,但如果没有太多的修改工作,它将无法与WebAPI的定制一起工作,而且遗憾的是,并非所有内容都可以在那里进行修改。WebAPI中的提供程序是完全可自定义的,因此这并不能完全替代HelpPage包。