如何处理 Swashbuckle 中的路径/路由参数？

Question

我有一个控制器，可以从路由中获取 ID。

[HttpGet]
[Route("{vehicleId}")]
public InfoDto GetInfo([FromUri] VehicleDetailsRequest request)
{
   return ...;
}

VehicleDetailsRequest 对象如下所示（Validator 来自 FluentValidation）：

[Validator(typeof(VehicleDetailsRequestValidator))]
public class VehicleDetailsRequest
{
    public int VehicleId { get; set; }

    public string Lang { get; set; }
}

我可以使用http://localhost/controller/123?lang=sv 查询此操作，但我的招摇文档如下所示：

如何让 Swashbuckle/Swagger 只显示一个 vehicleId 但仍保留 FluentValidation？

我正在使用 Swashbuckle 5.6 和 .Net Framework 4.6.2。

Answer 1

在我看来，动作方法签名有问题。 URL 中的参数应该出现在操作方法参数中。

另外，如果您只想在查询字符串中使用 lang，那么它也应该作为参数出现在操作中。

请注意，如果您在操作参数中指定对象，则其所有属性都将构成查询字符串。

因此，您的操作方法应如下所示：

[HttpGet]
[Route("{vehicleId}")]
public InfoDto GetInfo(int vehicleId, [FromUri] string lang)
{
   return ...;
}

这应该可以帮助您解决问题。