Route Group Fundamental Sample

[fiyazbinhasan]

Contributes to #26819

@tdykstra I accidentally removed my fork, so this PR #27177 has closed automatically. Creating a new PR.

However, it would be best if someone from the product team could intervene here. Maybe I'm missing some crucial configuration in order to make the linkGenerator work

These are very different configurations,

app.MapGroup("/{accessibility}/todos")
    .MapTodosApi()
    .WithTags("Todo Endpoints");

group.MapGet("/{id}", GetTodo).WithName("GetTodo");

With the following approach, you can't assign any name to your group. It will throw you an exception saying the name should be globally unique, hence linkGenerator won't be able to generate any links.

app.MapGroup("/public/todos")
    .MapTodosApi()
    .WithTags("Public Todo Endpoints");

app.MapGroup("/private/todos")
    .MapTodosApi()
    .RequireAuthorization();

In the sample, we should also consider showing a nested route group as well. What do you think?

[Rick-Anderson]

@captainsafia Please review, having problem with linkGenerator

[captainsafia]

@halter73 Do we happen to have a workaround for the link generation issue mentioned in #27177 or should we document it as a known issue?

[Rick-Anderson]

@fiyazbinhasan is link generation working now?

[halter73]

With the following approach, you can't assign any name to your group. It will throw you an exception saying the name should be globally unique, hence linkGenerator won't be able to generate any links.

Groups don't give you a free lunch when it comes to naming endpoints. Endpoints defined by MapGet, MapPost, etc... don't work with special RouteValuesAddress-based extension methods like GetPathByPage and GetPathByAction. It might be interesting to make these extension methods and make the key the combined RoutePattern.RawText (GetPathByRoutePattern?), but that's not something we've implemented yet.

As it stands, GetPathByName does work with MapGet, MapPost, etc... but that requires uniquely naming each endpoint using WithName or the EndpointNameAttribute which doesn't make sense on a group. This isn't a group limitation. This is just a current limitation of minimal route handlers. For now, I don't think we should demonstrate link generation in a group-focused sample.

Do we happen to have a workaround for the link generation issue mentioned in #27177 or should we document it as a known issue?

It turns out that the problem with that test was not related to groups after all. Even without the MapGroup calls, the page failed to generate a contact link. I fixed the test. dotnet/aspnetcore#44562

[tdykstra]

Thanks, @fiyazbinhasan