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

“密钥参数处理程序覆盖xml-doc注释文档”

我发现了同样的问题。每当我使用一个键（用[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>

Swagger忽略xml参数标记

1 个答案: