WebApi幫助頁面描述

Question

在助手頁面和引言段落上填充Webapi方法的描述是什麼？

Answer 1

根據此article您可以使用XML文檔註釋來創建文檔。要啓用此功能，打開文件區域/ HelpPage/App_Start/HelpPageConfig.cs並取消以下行：

​​

現在啓用XML文檔。在解決方案資源管理器中，右鍵單擊該項目並選擇屬性。選擇生成頁面。

在輸出下，檢查XML文檔文件。在編輯框中，輸入「App_Data/XmlDocument.xml」。

向控制器方法添加一些文檔註釋。例如：

/// <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"; 
} 

Answer 2

要查看您需要按照此說明：

1. 在客戶控制每一個動作都要有一個XML文檔
2. 打開項目的性質包含您的控制器並啓用XML文檔，如下所示：
3. 在爲HelpPageConfig類（區/ HelpPage/App_Start/HelpPageConfig.cs）取消對該行19 註冊方法，不要忘記改變這樣的文件路徑：

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

這一切你必須做的。 最後一件事是將在App_Data中創建的文件包含在您的項目中，以便文件將在生產中部署。