Swashbuckle.AspNetCore所需的查询字符串参数

时间:2019-05-17 12:39:20

标签: asp.net-core swagger swashbuckle

我有一个带有Swashbuckle.AspNetCore软件包的ASP.NET Core v2.1项目。 我的代码是:

    /// <summary>
    /// Set new android token for the current driver
    /// </summary>
    /// <remarks>
    /// Sample request:
    ///
    ///     PUT /SetToken?token=new_token
    ///
    /// </remarks>
    /// <param name="token">can't be null or empty</param>
    /// <returns></returns>
    /// <response code="204">If executed successfully</response>
    /// <response code="400">if token is null or empty</response>  
    /// <response code="404">if user is not a driver; if driver is not found (removed etc); if user does not have a profile</response>  
    [ProducesResponseType(204)]
    [ProducesResponseType(400)]
    [ProducesResponseType(404)]
    [HttpPut]
    [Route("SetToken")]
    [UserIsNotDriverException]
    [NullReferenceException]
    [DriverWithoutProfileException]
    public async Task<IActionResult> SetToken([FromQuery]string token)
    {

我想根据需要标记查询参数。我该怎么做?注意,我在查询字符串中传递参数,而不是在主体内部传递

2 个答案:

答案 0 :(得分:2)

您可以将BindRequired属性添加到您的参数中。

public async Task<IActionResult> SetToken([FromQuery, BindRequired]string token)

答案 1 :(得分:0)

您可以这样做。

public async Task<IActionResult> SetToken([FromQuery, SwaggerParameter("Token Description", Required = True)]string token)

使用此库Swashbuckle.AspNetCore.Annotations会有所帮助。