c# - Swagger 显示错误的查询参数

Question

我有这个 Controller 和操作方法:

[ApiController]
[Route("api/[controller]")]
public class AppointmentController : ControllerBase
{        
    [Route("{provider}/AvailableSlots")]
    [HttpGet]        
    public Task<AvailableSlotsResponse> GetAvailableSlots(Request<AvailableSlotsRequest> request)
    {
        return null;
    }
}

这是模型:

    public class Request<T> where T : class
    {
        [FromRoute]
        public string Provider { get; set; }
        [FromQuery(Name = "")]
        public T Model { get; set; }
    }

    public class AvailableSlotsRequest
    {
        //[FromQuery(Name = "Location")] //Would prefer not to have to use this
        public string Location { get; set; }
    }

我需要使用 Location 作为 URL 中的查询参数名称，以便按预期命中端点。

例如。 http://localhost/api/Appointment/Company/AvailableSlots?Location=SYD

但是，当我查看 Swagger 页面时，该参数名为 Model.Location，这让 API 的使用者感到困惑:

我可以使用 [FromQuery(Name = "Location")] 强制 Swagger 显示 Location，但这感觉非常多余，并且会重复属性名称。

这是我在 ConfigureServices() 中设置的 Swagger:

services.AddSwaggerDocument(document =>
            {
                document.PostProcess = d =>
                {
                    d.Info.Version = Configuration["APIVersion"];
                    d.Info.Title = $"{Configuration["ApplicationName"]} {Configuration["DomainName"]} API";
                };
            });

如何让 Swagger 显示 Location 而不是 Model.Location，而不必在 [FromQuery] 中重复“Location”一词> 属性？

Answer 1

向 Controller 参数添加属性[FromRoute]:

    public Task<AvailableSlotsResponse> GetAvailableSlots([FromRoute]Request<AvailableSlotsRequest> request)

删除 Model 属性中的属性 FromQuery，并取消 Location 属性中属性 FromQuery 的注释。