# 讓 ASP.NET Web API 自動產生 API 的說明網頁
###### tags: `程式設計`

## 操作順序
1. 選取 [Web API] 專案範本。 專案範本會建立名為 ValuesController的範例 API 控制器。 此範本也會建立 API 說明頁面。 [說明] 頁面的所有程式碼檔案都會放在專案的 [區域] 資料夾中。

2. 打開 Area/HelpPage/App_Start/HelpPageConfig.cs，並取消註解下面這一段程式碼：

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

3. 在方案總管中，以滑鼠右鍵按一下專案，然後選取 [屬性]。 選取 [建置] 頁面。

在 [輸出] 下，檢查XML檔檔案。 在編輯方塊中，輸入 "App_Data/XmlDocument.xml"。

4. 在 api 的程式碼上方，加入類似這樣的註解
在程式碼前手動輸入///，會自動產生summary的區塊

/// <summary>
/// 這是程式說明
/// </summary>
/// <param name="id">這是變數說明</param>
public string Get(int id)
{
    return "value";
}

5. 建置程式並且執行網站，說明文件會自動出現在 /Help 的頁面

## 參考來源
https://docs.microsoft.com/zh-tw/aspnet/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages