Swagger忽略xml參數標記

我爲我的Asp.net webapi文檔使用Swagger + xml註釋文件。Swagger忽略xml參數標記

顯示摘要標記中的值，但忽略param標記。

我有一個OdataController V4

// GET: api/L_controller('L') 

    /// <summary> 
    /// This is my summary 
    /// </summary> 
    /// <param name="key">This is my Description</param> 

    [EnableQuery] 
    public IEnumerable<L_model> GetL_controller([FromODataUri] string key) 
    {   
     return someResult; 
    }

我到底做錯了什麼？

來源

2017-04-25 Schauby

似乎有什麼不對您的代碼，但它在Swashbuckle.Odata了一個錯誤：https://github.com/rbeauchamp/Swashbuckle.OData/issues/73

「鍵PARAM處理XML重寫-doc的註釋文檔」

我已經觀察到的同樣的問題。每當我使用一個密鑰（帶註釋的實體領域[鍵]）的描述只是

鍵：代碼

（代碼是關鍵領域的名字在我的實體）

的documantation其他的非關鍵參數工作正常。一個解決辦法可能是一個言論的標籤添加到您的文檔，您可以使用它添加註釋有關參數，如：

/// <summary> 
/// retrive user by key 
/// {URL}/User(key) 
/// </summary> 
/// <remarks>this documentaion will be displayed</remarks> 
/// <param name="key">this documentation will be ignored</param>

來源

2017-04-26 11:46:54 jps

謝謝您的解決方案，它工作得很好，因爲我張貼的問題我有自定義swagger文檔更多，所以我實施了IDocumentFilter – Schauby

歡迎您，很高興幫助 – jps

Swagger忽略xml參數標記

回答

相關問題