ASP.NET Core Web Api中有多个具有多个查询字符串参数的get方法

时间:2016-08-03 08:47:36

标签: c# asp.net-core asp.net-core-routing

我正在构建一个web api,我有一个资源,必须有3个get方法,如下所示:

    [HttpGet]
    [Route("{city}/{streetName}/{streetNumber}/{littera}")]
    public IActionResult GetByAddress([FromQuery]string city, [FromQuery]string streetName, [FromQuery]int streetNumber, [FromQuery]string littera)
    {
        var model = _availabilityService.FindByAddress(city, streetName, streetNumber, littera);
        return Ok(model);
    }

    [HttpGet("{pointId}")]
    public IActionResult GetByPointId(string pointId)
    {
        var model = _availabilityService.FindByPointId(pointId);
        return Ok(model);
    }

    [HttpGet]
    [Route("{xCoordinate}/{yCoordinate}")]
    public IActionResult GetByCoordinates([FromQuery]decimal xCoordinate, [FromQuery]decimal yCoordinate)
    {
        var model = _availabilityService.FindByCoordinates(xCoordinate, yCoordinate);
        return Ok(model);
    }

只有一个参数(pointId)的get方法工作正常,因为它不被视为查询字符串,而是id和id。但是,其余两种方法无法通过ASP.NET中的路由器进行区分。

我真的很茫然,无法弄清楚为什么它不起作用。我能够解决的是,如果我删除其中一种方法,另一种方法可以正常工作。

有关我做错的任何建议吗?

仅供参考,相应的网址应该如下所示:

api/1.0/availabilities?city=Metropolis&streetName=Superstreet&streetNumber=1&littera=A

/api/1.0/availabilities?xCoordinate=34.3444&yCoordinate=66.3422

谢谢!

1 个答案:

答案 0 :(得分:12)

首先,您要混合RouteParameters和QueryParameters。

此:

[HttpGet]
[Route("{xCoordinate}/{yCoordinate}")]
public IActionResult GetByCoordinates([FromQuery]decimal xCoordinate, [FromQuery]decimal yCoordinate)
{
    var model = _availabilityService.FindByCoordinates(xCoordinate, yCoordinate);
    return Ok(model);
}

将控制器操作GetByCoordinates映射到这样的路线:

/api/1.0/availabilities/34.3444/66.3422

但是您还指定要从查询参数绑定xCoordinateyCoordinate。因此,上面的url会匹配操作,但xCoordinateyCoordinate会绑定到它的默认值(在本例中为0)。

因此,要获得所需的路线,您不应该声明路线参数:

[HttpGet]
[Route("")] // <- no route parameters specified
public IActionResult GetByCoordinates([FromQuery]decimal xCoordinate, [FromQuery]decimal yCoordinate)
{
   // will be matched by e.g.
   // /api/1.0/availabilities?xCoordinate=34.3444&yCoordinate=66.3422
}

现在您所需的路线将匹配。

注意:您无法将两个操作映射到同一路由 - 路由中间件无法知道选择哪个。因此,从GetByAddress中删除路由参数将有效地将两个操作映射到同一路径:

/api/1.0/availabilities?{any=number&of=query&parameters=here}

因此,您必须将它们区分为另一个路段,例如。

[HttpGet]
[Route("address")] // <--
public IActionResult GetByAddress([FromQuery]string city, [FromQuery]string streetName, [FromQuery]int streetNumber, [FromQuery]string littera)
{
    // will be matched by e.g.
    // api/1.0/availabilities/address?city=Metropolis&streetName=Superstreet&streetNumber=1&littera=A
}

进一步阅读:

ModelBinding / Routing

快速提示:

Microsft loglevel设置为Debug中的appsettings.json(在标准Asp.Net核心Web应用程序模板中自动生成),您将获得有关路由选择/错误的非常有用的信息,同时选择路由在kestrel下运行时的控制台输出。

{
  "Logging": {
  "IncludeScopes": false,
  "LogLevel": {
    "Default": "Debug",
    "System": "Information",
    "Microsoft": "Debug"
}

或者在StartUp.csLogLevel.Debug中设置调试记录器,您可以直接在Visual Studio中获得调试输出中的相同信息。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
    {
        // ...

        loggerFactory.AddDebug(LogLevel.Debug);

        // ...
    }