ASP.NET Web API 建立協助頁

標籤：word   ppa   技術分享   new   art   分享   doc   操作   protected   

1. 安裝 Microsoft.AspNet.WebApi.HelpPage 程式包

Install-Package 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. 效果

Help Page

Help/Api/POST-api-Values

ASP.NET Web API 建立協助頁