Utilizzare parametri a livello di controller nel routing di ASP.NET Core

di Marco De Sanctis, in ASP.NET Core,

Quando creiamo delle RESTful API, è piuttosto comune avere dei parametri nel path comuni a più action. Immaginiamo per esempio di avere a che fare con un programma di chat. L'endpoint che ci permette di recuperare gli ultimi messaggi di una particolare "Room" potrebbe avere un URL simile al seguente, in cui il path "messages" appare dopo il parametro "5", ossia l'ID della room.

Come possiamo modellare un simile URL nel routing di ASP.NET Core?

Se abbiamo creato un MessagesController, specifico per i messaggi, probabilmente avremo configurato un routing simile al seguente, in cui roomId è un parametro della route a livello di controller - e non di singola action, come più spesso accade.

[Route("rooms/{roomId:int}/[controller]")]
[ApiController]
public class MessagesController : ControllerBase
{
    ...
}

Come possiamo accedere a un tale parametro nel nostro codice?

Una prima possibilità è quella di aggiungere questo parametro al metodo della action:

[HttpGet]
public string Get(int roomId)
{
    return $"Room {roomId} has no messages";
}

Questo sistema funziona anche se il parametro - come nel nostro caso - non è presente nel routing specifico della action, ma è definito nel suo parent (il controller). Si tratta di una tecnica molto semplice, che però ha il difetto di duplicare questo parametro ovunque nel codice. Nel caso dovessimo cambiarne il nome o il tipo, dovremmo andare a modificare ogni singola action che lo utilizzi.

Alternativamente, possiamo pensare di esporlo come proprietà nel controller stesso:

[Route("rooms/{roomId:int}/[controller]")]
[ApiController]
public class MessagesController : ControllerBase
{
    public int RoomId => int.Parse(
        this.HttpContext.Request.RouteValues["roomId"].ToString());

    [HttpGet]
    public string Get()
    {
        return $"Room {this.RoomId} has no messages";
    }
}

In questo modo, possiamo evitare di includere il parametro nelle singole action, che possono leggerne il valore tramite la proprietà appena creata.

Commenti

Visualizza/aggiungi commenti

| Condividi su: Twitter, Facebook, LinkedIn

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi