Square brackets in the controller Route in ASP.NET Core

Square brackets in the controller Route in ASP.NET Core

In ASP.NET Core, square brackets are used to define optional route parameters in the controller Route attribute.

For example, consider the following code snippet:

[Route("api/[controller]")] public class ProductsController : ControllerBase { [HttpGet("{id?}")] public ActionResult<Product> Get(int? id) { //... } }

In the above example, the [controller] token in the Route attribute will be replaced with the name of the controller, which is Products in this case. The HttpGet attribute defines a route for the Get action method with an optional id parameter. The ? character after the id parameter makes it optional. If the id parameter is not provided in the URL, the id parameter will be null.

So, when the URL https://localhost:5001/api/products is requested, the Get action method will be called with id parameter as null. When the URL https://localhost:5001/api/products/1 is requested, the Get action method will be called with id parameter as 1.

Examples

  1. "ASP.NET Core controller Route attribute square brackets example"

    • Description: Learn how to use square brackets in the Route attribute of an ASP.NET Core controller to define custom routes.
    • Code:
      [Route("api/[controller]")] public class MyController : ControllerBase { // Controller actions and methods }

  2. "ASP.NET Core route parameters in square brackets tutorial"

    • Description: Explore how to include route parameters in square brackets for dynamic URL segments in ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/{id}")] public IActionResult GetById(int id) { // Action logic to retrieve data by id }

  3. "ASP.NET Core attribute routing with square brackets best practices"

    • Description: Discover best practices for using square brackets in attribute routing for clean and maintainable ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/[action]")] public class MyController : ControllerBase { // Controller actions and methods }

  4. "Customizing ASP.NET Core route templates with square brackets"

    • Description: Customize route templates using square brackets to define specific URL patterns in ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/[action]/{year:int}/{month:range(1,12)}")] public IActionResult GetByDate(int year, int month) { // Action logic for filtering data by date }

  5. "Nested square brackets in ASP.NET Core route attributes example"

    • Description: Learn how to use nested square brackets in route attributes for hierarchical URL structures in ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/[action]/{category}/{id?}")] public IActionResult GetByCategory(string category, int? id) { // Action logic for filtering data by category and optional ID }

  6. "ASP.NET Core attribute routing constraints with square brackets"

    • Description: Implement constraints within square brackets to restrict the input values for route parameters in ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/{id:int}")] public IActionResult GetById(int id) { // Action logic to retrieve data by integer id }

  7. "ASP.NET Core optional route parameters in square brackets example"

    • Description: Understand how to make route parameters optional using square brackets in ASP.NET Core controllers.
    • Code:
      [Route("api/[controller]/{id?}")] public IActionResult GetById(int? id) { // Action logic to handle both cases: with and without id }

  8. "ASP.NET Core attribute routing with area and square brackets"

    • Description: Combine area routing with square brackets for organized and structured routing in ASP.NET Core controllers.
    • Code:
      [Area("Admin")] [Route("admin/[controller]/[action]")] public class AdminController : ControllerBase { // Controller actions and methods for the admin area }

  9. "ASP.NET Core route tokens with square brackets overview"

    • Description: Gain an overview of route tokens and their usage within square brackets in ASP.NET Core controllers for flexible routing.
    • Code:
      [Route("api/[controller]/{action=Index}")] public class MyController : ControllerBase { // Default action logic }

  10. "ASP.NET Core global route prefixes with square brackets guide"

    • Description: Explore how to use global route prefixes with square brackets to apply consistent patterns across multiple controllers in ASP.NET Core.
    • Code:
      [Route("api/v{version:apiVersion}/[controller]")] [ApiController] public class MyController : ControllerBase { // Controller actions and methods }

More Tags

graph-tool file-uri cllocationmanager wildfly boggle ip-address lyx 64-bit windows-1252 data.table

More C# Questions

More Everyday Utility Calculators

More Statistics Calculators

More Date and Time Calculators

More Other animals Calculators