如何在 ASP.NET Web Api 帮助页面中记录可选的查询字符串参数？

Question

ASP.Net Web Api 帮助页面似乎会自动确定参数是否在请求 Uri 或正文中。如何记录作为 QueryString 参数的选项参数？

例如，我可能有一个 RESTful Url，例如

[GET] api/Books?relatedToBookId=xx

其中“relatedToBookId”是可选的 queryString 参数。

通常将 FromUri 或 FromBody 的参数放入 cmets 中

<param name="variableName">blah blah</param>

Answer 1

您可以执行以下操作，您的可选查询字符串参数信息将显示在帮助页面中。

在下面的代码中，relatedToBookId 是一个来自查询字符串的可选参数。

    /// <summary>
    /// Gets list of books
    /// </summary>
    /// <param name="relatedToBookId">Your description here</param>
    /// <returns>returns list of books</returns>
    public IEnumerable<Book> GetBooks(int? relatedToBookId = null)

另外，如果您想提及此参数是可选的，您可以执行以下操作：

• 转到已安装的文件（Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml）

• 将与case ApiParameterSource.FromUri 相关的条件更新为以下内容：

  case ApiParameterSource.FromUri: <p>Define this parameter in the request <b>URI</b>.</p> if(parameter.ParameterDescriptor.IsOptional) { <p>This parameter is <b>optional</b>.</p> } break;