Qué es y cómo usar el enrutamiento por atributos en ASP.NET

El enrutamiento por atributos nos permite especificar las rutas URL directamente en los controladores y acciones usando atributos como [Route], [HttpGet], [HttpPost].

Es un enfoque muy flexible, cómodo y fácil de mantener. Así que es el método de routing preferido y más empleado en aplicaciones de ASP.NET.

Configuración inicial

Antes de poder usar el routing por atributos, primero debemos tenerlo habilitado en el archivo Program.cs.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();

var app = builder.Build();

app.MapControllers(); // Habilita el enrutamiento por atributos
app.Run();

Atributos de enrutamiento principales

Tenemos dos “familias” de parámetros disponibles para usar.

Vamos a ver cada uno de ellos,

[Route("api/productos")]
public class ProductosController : ControllerBase
{
    // Aquí las rutas empiezan con /api/productos
}

[HttpGet]
public IActionResult Obtener() { ... }

Ejemplo completo

Vamos a ver como usa cada uno de ellos con un ejemplo completo, donde los usemos de forma conjunta,

[Route("api/productos")]
public class ProductosController : ControllerBase
{
    [HttpGet] // GET /api/productos
    public IActionResult ObtenerTodos() => Ok();

    [HttpGet("{id}")] // GET /api/productos/5
    public IActionResult ObtenerPorId(int id) => Ok();

    [HttpPost("crear")] // POST /api/productos/crear
    public IActionResult Crear([FromBody] Producto producto) => Ok();

    [HttpDelete("borrar/{id}")] // DELETE /api/productos/borrar/5
    public IActionResult Borrar(int id) => Ok();
}

Parámetros de ruta

Por supuesto, el enrutamiento por atributos nos permite recibir parámetros, tanto en rutas simples como en patrones complejos.

Estos parámetros pueden capturarse directamente desde la URL y automáticamente mapearse a los argumentos de nuestros métodos.

Parámetros básicos

Los parámetros se definen entre llaves {} y se mapean automáticamente a los parámetros del método:

[HttpGet("categoria/{categoria}/producto/{id}")]
public IActionResult GetProductoPorCategoria(string categoria, int id)
{
    // GET api/productos/categoria/electronicos/producto/123
    return Ok($"Producto {id} en categoría {categoria}");
}

Patrones avanzados de rutas

[Route("api/[controller]")]
public class OrderController : ControllerBase
{
    [HttpGet("{orderId}/items/{itemId}")]
    public IActionResult GetOrderItem(int orderId, int itemId)
    {
        // Lógica para obtener el ítem del pedido
    }
}

[HttpGet("pagina/{numero:int=1}")]
public IActionResult ObtenerPagina(int numero)
{
    // GET api/productos/pagina -> numero = 1
    // GET api/productos/pagina/5 -> numero = 5
    return Ok();
}

[HttpGet("lista/{categoria?}")]
public IActionResult ListarProductos(string categoria = null)
{
    // GET api/productos/lista
    // GET api/productos/lista/electronicos
    return Ok();
}

[HttpGet("buscar/{termino}")]
[HttpGet("search/{termino}")]
public IActionResult BuscarProductos(string termino)
{
    // Accesible desde ambas rutas:
    // GET api/productos/buscar/laptop
    // GET api/productos/search/laptop
    return Ok();
}

Restricciones de ruta

Las restricciones de ruta permiten limitar los valores que pueden tomar los parámetros en una ruta.

Algunas de las restricciones más comunes incluyen:

Para aplicarlas, podemos especificar tipos y restricciones directamente en el template:

[Route("api/[controller]")]
public class UserController : ControllerBase
{
    [HttpGet("{id:int}")]
    public IActionResult GetUser(int id)
    {
        // Lógica para obtener el usuario
    }

    [HttpGet("{name:alpha}")]
    public IActionResult GetUserByName(string name)
    {
        // Lógica para obtener el usuario por nombre
    }
}