您可以为您的 api 方法创建帮助页面。
按照以下步骤在您的 Web api 应用程序中添加帮助页面:
从工具菜单中,选择库包管理器,然后选择包管理器控制台。在包管理器控制台窗口中,键入以下命令之一:
For a C# application: Install-Package Microsoft.AspNet.WebApi.HelpPage
For a Visual Basic application: Install-Package Microsoft.AspNet.WebApi.HelpPage.VB
另外,请务必注册区域。在 Global.asax 文件中,将以下代码添加到 Application_Start 方法中(如果尚未存在):
protected void Application_Start()
{
// Add this code, if not present.
AreaRegistration.RegisterAllAreas();
}
添加 API 文档:
config.SetDocumentationProvider(新的 XmlDocumentationProvider(
HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));
要将简单的测试客户端添加到 ASP.NET Web API 帮助页面,请按照以下步骤操作:
第 1 步:安装测试客户端包
从 NuGet 包管理器安装 WebApiTestClient 包。确保“包括预发布”,然后输入“WebApiTestClient”并点击安装。
第 2 步:在帮助页面上连接测试客户端
打开文件 Api.cshtml(在 Areas\HelpPage\Views\Help 下)并添加以下内容:
@Html.DisplayForModel("TestClientDialogs")
@Html.DisplayForModel("TestClientReferences")
现在运行应用程序并在测试客户端的帮助下使用 ajax 调用测试 api。
请参考Creating Help Pages for ASP.NET Web API
之后Adding a simple Test Client to ASP.NET Web API Help Page
这将使测试客户端使用 ajax 请求测试您的 api。
请告诉我,这对你有用吗?