Azure函数和Swagger UI-如何在Swagger UI中显示查询字符串参数？

Question

我有以下Azure函数，它是HTTP触发的。我已经使用这里的链接为我的endpoint设置了Swagger。下面的API需要一组查询字符串参数，即“name”、“email”、“phone”，因此它可以针对目标对象进行一些搜索。目前，函数的主体当然还没有实现，这对这个问题来说并不重要。

我的问题是：如何在swagger UI中显示查询字符串参数？

函数：

[FunctionName(nameof(GetBookingCalendarsFunction))]
 public async Task<IActionResult> GetAllAsync(
        [HttpTrigger(AuthorizationLevel.Anonymous, "GET", Route = "bookings")] HttpRequest request,
        ILogger log)
    {
        log.LogInformation("C# HTTP trigger function processed a request.");

        return new OkObjectResult($"Name: {request.Query["name"]}, email: {request.Query["email"]}, phone: {request.Query["phone"]}");
    }

  [FunctionName(nameof(GetBookingCalendarsFunction))]
    public async Task<IActionResult> GetAllAsync(
        [HttpTrigger(AuthorizationLevel.Anonymous, "GET", Route = "bookings/name={name}&email={email}&phone={phone}")] HttpRequest request,
        string name, string email, string phone,
        ILogger log)
    {
        log.LogInformation("C# HTTP trigger function processed a request.");

        return new OkObjectResult($"Name: {request.Query["name"]}, email: {request.Query["email"]}, phone: {request.Query["phone"]}");
    }

Answer 1

由于您使用包AzureExtensions.swashbuckle在Azure函数中集成Swagger，因此我们可以使用属性QueryStringParameter根据需要配置查询字符串。有关更多详情，请参阅此处

例如

 [FunctionName("GetBookingCalendarsFunction")]
        [QueryStringParameter("name", "this is name", DataType = typeof(string), Required = false)]
        [QueryStringParameter("email", "this is email", DataType = typeof(string), Required = false)]
        [QueryStringParameter("phone", "this is phone", DataType = typeof(string), Required = false)]
        public static async Task<IActionResult> GetAllAsync(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "bookings")] HttpRequest req,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

           

            return new OkObjectResult($"Name: {req.Query["name"]}, email: {req.Query["email"]}, phone: {req.Query["phone"]}");
        }