asp.net-mvc – 如何在ASP.NET WebApi帮助页面中记录可选的Query

发布时间：2020-12-16 04:36:02 所属栏目：asp.Net 来源：网络整理

导读：ASP.Net Web Api帮助页面似乎自动确定参数是否在Request Uri或Body中.如何记录QueryString参数的选项参数？例如,我可能有一个RESTful Url,例如 [GET] api/Books?relatedToBookId=xx 其中“relatedToBookId”是可选的queryString参数. 通常,将FromUri或FromB

ASP.Net Web Api帮助页面似乎自动确定参数是否在Request Uri或Body中.如何记录QueryString参数的选项参数？

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

[GET] api/Books?relatedToBookId=xx

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

通常,将FromUri或FromBody的参数放入注释中

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

解决方法

您可以执行以下操作,您的可选查询字符串参数信息将显示在HelpPage中.

在下面的代码relatedToBookId是来自Query String的可选参数.

/// <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)
>将与案例ApiParameterSource.FromUri相关的条件更新为以下内容：

case ApiParameterSource.FromUri：在请求 URI中定义此参数.如果(parameter.ParameterDescriptor.IsOptional){此参数是可选.}打破;

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!