Web API 配置Help Page

Web API提供了一个库在运行时可以自动生成帮助页面。

创建API Help Pages

帮助页面的所有代码文件放置在区域项目的文件夹。

当运行应用时，首页将显示API链接，路径 /Help。

这个链接带给你一个API总结页面。

每个API与性的链接页面的详细信息,包括示例请求和响应。

Adding Help Pages to an Existing Project

创建一个链接在razor视图,添加以下:

cshtml

@Html.ActionLink("API", "Index", "Help", new { area = "" }, null)

添加代码Application_Start 方法:

C#

protected void Application_Start()
{
    // Add this code, if not present.
    AreaRegistration.RegisterAllAreas();

    // ...
}

Adding API Documentation

和取消注释以下行:

C#

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

选择构建页面。

在编辑框中,输入“App_Data / XmlDocument.xml”。

在 /Controllers/ValuesControler.cs，添加注释

Copy

C#

/// <summary>
/// Gets some very important data from the server.
/// </summary>
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>
public string Get(int id)
{
    return "value";
}

(在部署应用程序时,请确保部署的XML文件)。