ASP.Net WebAPI中添加helppage幫助頁面

一、自動創建帶幫助的WebAPI

1、首先創建項目的時候選擇WebAPI,如下圖所示，生成的項目會自動生成幫助文檔。

2、設置調用XML文檔的代碼

3、設置項目注釋XML文檔生成目錄，項目——屬性——生成——勾選生成XML文檔——設置目錄為App_Data

4、Values控制器中的代碼

 1     /// <summary>
 2     /// Values控制器
 3     /// </summary>
 4     public class ValuesController : ApiController
 5     {
 6        /// <summary>
 7        /// Get請求
 8        /// </summary>
 9        /// <returns></returns>
10         public IEnumerable<string> Get()
11         {
12             return new string[] { "value1", "value2" };
13         }
14      }

5、查看生成效果，啟動項目——點API——查看幫助文檔

helpage

Help/Api/GET-api-Values

二、在已有項目中添加幫助頁

1、新建一個普通的webapi項目——在nuget中添加Microsoft.AspNet.WebApi.HelpPage

 

2. 注冊 Area

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
}

3. HelpPageConfig 啟用 SetDocumentationProvider

 WebApplication/Areas/HelpPage/App_Start/HelpPageConfig.cs 目錄下，找到下面代碼，並取消注釋（App_Data 改為 bin）：

public static void Register(HttpConfiguration config)
{
    //// Uncomment the following to use the documentation from XML documentation file.
    config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/XmlDocument.xml")));
}

4. WebApplication Build 配置 XmlDocument 輸出路徑

5. ValuesController 代碼

/// <summary>
/// Values控制器
/// </summary>
public class ValuesController : ApiController
{
    ........

    /// <summary>
    /// POST 操作
    /// </summary>
    /// <param name="value">value值</param>
    public void Post([FromBody]string value)
    {
    }
}

6. 效果