asp.net - Swagger 忽略 xml 参数标签

Question

我正在为我的 Asp.net webapi 文档使用 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;
    }

我做错了什么？

Answer 1

您的代码似乎没有任何问题，但这是 Swashbuckle.Odata 中的一个错误:https://github.com/rbeauchamp/Swashbuckle.OData/issues/73

"Key param handler overwrites xml-doc commented documentation"

我也发现了同样的问题。每当我使用键(用 [key] 注释的实体字段)时，描述就是

键:代码

(代码是我的实体中关键字段的名称)

其他非关键参数的记录工作正常。 一种解决方法可能是在文档中添加备注标签，用于添加有关参数的注释，例如:

/// <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>