ASP.NET Core, Web API RouteAttribute with query string as template

Question

I need to make a ASP.NET Core, Web API that supports multiple HttpGet verbs with the only difference being a query string, but it seems that query strings cannot be part of the route template -- is that true?

The route templates are very similar, in fact they only differ by query string.

[Authorize]
public class SymbolsController : Controller
{
    [
        HttpGet, 
        Route("api/symbols")
    ]
    public Task<IEnumerable<Symbol>> Symbols([FromServices] ISymbolService symbolService)
    {
        return symbolService.GetSymbolsAsync();
    }

    [
        HttpGet, 
        Route("api/symbols?{childrenOf=id}")
    ]
    public Task<IEnumerable<Symbol>> ValidChildren(
        [FromQuery] Guid id, 
        [FromServices] ISymbolService symbolService)
    {
        return symbolService.GetValidChildrenAsync(id);
    }
}

This throws an exception as the ? is not a valid character in the route template. How can I achieve this?

David Pine · Accepted Answer · 2020-05-15 19:06:37Z

9

I figured out an easier and more straightforward solution. I am simply using the FromQuery attribute and leaving the template simple. I check for the presence of the id variable and handle it accordingly.

[HttpGet, Route("api/symbols")]
public Task<IEnumerable<Symbol>> Symbols(
    [FromQuery] Guid id, 
    [FromServices] ISymbolService symbolService) => 
    id == default
        ? symbolService.GetSymbolsAsync()
        : symbolService.GetValidChildrenAsync(id);

edited May 15, 2020 at 19:06

answered Aug 16, 2016 at 15:29

David Pine

24.6k11 gold badges82 silver badges113 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Nicolas Law-Dune Over a year ago

you can use [FromUri] for a complex object.

David Pine · Accepted Answer · 2016-08-16 16:30:44Z

1

//eg GET api/symbols
//eg GET api/symbols?childrenOf={someGuid}
[HttpGet("api/symbols")]
public Task<IEnumerable<Symbol>> Symbols(
    [FromServices] ISymbolService symbolService, 
    Guid? childrenOf = null)
{
    if (childredOf.HasValue) {
        return ValidChildren(childredOf.Value, symbolService);
    }
    return symbolService.GetSymbolsAsync();
}

Task<IEnumerable<Symbol>> ValidChildren(
    Guid id, 
    ISymbolService symbolService)
{
    return symbolService.GetValidChildrenAsync(id);
}

edited Aug 16, 2016 at 16:30

David Pine

24.6k11 gold badges82 silver badges113 bronze badges

answered Aug 16, 2016 at 15:27

Nkosi

249k38 gold badges472 silver badges506 bronze badges

Collectives™ on Stack Overflow

ASP.NET Core, Web API RouteAttribute with query string as template

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related