4

我無法弄清楚如何在我的Web API中獲取幫助頁面,以顯示除None以外的任何資源描述。它有IHttpActionResult鏈接,然後是「無」。之後。通過將config.SetActualResponseType(typeof(ComplexType), "Controller", "Action");添加到HelpPageConfig.cs中,我得到了示例。我的控制器看起來是這樣的:Web API幫助頁面上的資源描述顯示「無」。

/// <summary> 
/// My description 
/// </summary> 
[Route("MyRoute")] 
public IHttpActionResult Get() 
{ 
    try 
    { 
     //throw new Exception("TEST"); 
     return Ok(returnValue); 
    } 
    catch (Exception ex) 
    { 
     *Company Log Method* 
     return NotFound(); 
    } 
} 

我不知道我從HelpPageConfig.cs否則任何地方丟失,請。也許一個新的眼睛可以捕捉到一些東西。先謝謝您的幫助!

回答

7

我只需要在我的控制器頂部包含using System.Web.Http.Description;之後,在我的動作之上添加[ResponseType(typeof(MyModel))]。我現在正在獲取我的模型的描述,而不是IHttpActionResult和「無」。

0

(這大概應該是一個評論,但我沒有足夠的代表還)

我會開始斷裂區\ HelpPage指向不同點 - 例如XmlDocumentationProvider - 看看是否給你任何線索。沒有什麼可以跳到我身上。

難道是你改變了輸出XML幫助文件的位置,而沒有更新傳遞給XmlDocumentationProvider的文檔路徑?該路徑通過「屬性」頁面 - 輸出XML文檔文件進行設置。

+0

設置斷點的好建議,雖然我不知道在哪裏設置它們。就XML文件而言,HelpPageConfig.cs和Properties中的路徑是相同的,並且我將它包含在項目中,所以不是這樣。 – dkiefer 2014-11-04 12:38:35