Plusieurs paramètres facultatifs de routage

Pour résoudre votre problème, vous devez prendre en compte ce genre de choses:

• vous pouvez vous inscrire plus d'une voie. La première route enregistrée qui peut gérer une URL il va la traiter.
• vous pouvez utiliser quelque chose en dehors de slash / comme séparateur, pour fabriquer des pièces d'un itinéraire à distinguer
• vous pouvez utiliser le paramètre contraintes, généralement des expressions régulières, pour le rendre plus facile de découvrir si un paramètre est de l'un ou l'autre genre
• vous pouvez spécifier des valeurs par défaut pour ces paramètres, et, si vous le faites, la méthode d'action doivent avoir des valeurs par défaut (sauf si MVC, que seuls les oblige à accepter les valeurs null ou de type de référence)

Que vous n'avez pas de dire comment votre URL regarde comme je vais vous montrer mes propres exemples.

Supposons que vous avez un TestController Web de l'API de la classe Contrôleur avec une action comme ceci:

//GET api/Test/TestAction/...
[HttpGet]
public object TestAction(int param1, DateTime startDate, DateTime endDate, 
                         int? param2 = null)
{
    return new
    {
        param1 = param1,
        param2 = param2,
        startDate = startDate,
        endDate = endDate
    }.ToString();
}

REMARQUE: avec les routes par défaut d'une API Web du contrôleur de la méthode nommée GetXxx est disponible à HTTP GET, une méthode nommée PostXxx est disponible à l'adresse HTTP POST et ainsi de suite. Cependant, une fois que vous incluez Controller et Action dans le modèle d'URL, vous devez utiliser le [HttpXxx] attributs pour faire de votre méthode à la méthode HTTP.

Paramètre optionnel(s) dans le milieu

Dans ce premier exemple, je suppose que les deux param1, et param2 sont des nombres entiers, et stardDate et endDate sont les dates:

http://myhost/api/Mycontroller/Myaction/12/22/2014-12-01/2014-12-31
http://myhost/api/Mycontroller/Myaction/22/2014-12-01/2014-12-31

Si vous souhaitez que la première URL de faire correspondre les paramètres tels que:

param1 = 12; param2 = 22; startDate = 2014-12-01; endData = 2014-12-31

et la deuxième du genre:

param1 = 12; param2 = null; startDate = 2014-12-01; endData = 2014-12-31

Vous devez vous inscrire de deux routes, l'une qui correspond à chaque structure d'URL, c'est à dire

//for the 1st
routeTemplate: "api/{controller}/{action}/{param1}/{param2}/{startDate}/{endDate}"
//for the 2nd
routeTemplate: "api/{controller}/{action}/{param1}/{startDate}/{endDate}"

Noter que, dans ce cas, les deux voies sont mutuellement exclusifs, c'est à dire une URL unique peut correspondre qu'à une seule des routes, de sorte que vous pouvez les enregistrer dans toutes les autres.

Cependant, vous devez noter que la deuxième URL n'est pas de définir une valeur de param2, et la TestAction méthode exige. Ceci ne fonctionnerait pas: vous devez ajouter une valeur par défaut pour ce paramètre, à la fois dans le contrôleur de la méthode et de la route d'inscription:

• paramètre action int? param2 = null (C# nécessite paramètre facultatif pour être la dernière).
• l'itinéraire doit inclure la valeur par défaut: defaults: new { param2 = RouteParameter.Optional }

C'est la façon de résoudre le paramètre facultatif dans le milieu de problème. En général, vous aurez besoin de définir plusieurs itinéraires, en fonction du nombre de paramètres optionnels, il y a, et de déclarer ces paramètres avec des valeurs par défaut, dans le site Web de l'API de la méthode d'action.

REMARQUE: comme je l'ai écrit ci-dessus, dans MVC vous n'avez pas besoin de spécifier une valeur par défaut dans le paramètre de méthode pour que cela fonctionne

Contraintes de paramètres

La spécification de contraintes pour un paramètre de route a deux conséquences:

1. Il ya une garantie que la valeur du paramètre a le format attendu
2. Plus important encore, la route sera de gérer uniquement l'URL si le format est l'un prévu. Si cela vous aide à faire de votre URL plus sélectifs, ce qui rend plus souple.

Vous suffit d'ajouter un constraint paramètre sur la route de l'enregistrement, comme ceci:

config.Routes.MapHttpRoute(
    name: "Multiparam2",
    routeTemplate: "api/{controller}/{action}/{param1}/{param2}/{startDate}/{endDate}",
    constraints: new
    {
        startDate = @"20\d\d-[0-1]?\d-[0-3]?\d", //regex
        endDate = @"20\d\d-[0-1]?\d-[0-3]?\d" //regex
    },
    defaults: new object { }
);

Notez qu'il est nécessaire de spécifier un defaults paramètre, même si elle est vide.

REMARQUE: les contraintes dans ce cas sont une expression régulière qui correspond uniquement aux dates dans l'année 20XX, le mois exprimée en un seul chiffre, ou par 0x ou 1x, et la date comme un seul chiffre ou 0x, 1x, 2x ou 3x, séparés par des tirets. Donc, cette expression va correspondre à 2012-1-1 ou 2015-12-30, mais pas 1920-12-30. Vous devez adapter les regex à vos besoins.

Paramètres facultatifs à la fin

À cette époque, j'ai expliqué comment soutenir des paramètres facultatifs, et la façon de spécifier les formats (contraintes) pour eux, pour correspondre à un template de route.

La façon habituelle de définir les paramètres facultatifs est de le faire à la fin de l'URL de modèle, et, dans ce cas, si il manque des params dans une route, ils doivent être tous à la fin de la route. (Comparez cela avec, en option, dans le milieu: elles nécessitent des voies différentes).

Dans cet exemple, si vous voulez rendre facultatif le param2, et la startDate et endDate, vous devez définir dans l'itinéraire d'enregistrement, et de définir des valeurs de paramètre par défaut dans la méthode d'action.

Le code final devrait ressembler à ceci:

[HttpGet]
public object TestAction(int param1, int? param2 = null, DateTime? startDate = null, 
                         DateTime? endDate = null)
{
    return new
    {
        param1 = param1,
        param2 = param2,
        startDate = startDate,
        endDate = endDate
    }.ToString();
}



config.Routes.MapHttpRoute(
    name: "Multiparam1",
    routeTemplate: "api/{controller}/{action}/{param1}/{startDate}/{endDate}",
    constraints: new
    {
        startDate = @"20\d\d-[0-1]?\d-[0-3]?\d",
        endDate = @"20\d\d-[0-1]?\d-[0-3]?\d"
    },
    defaults: new
    {
        param2 = RouteParameter.Optional,
        startDate = RouteParameter.Optional,
        endDate = RouteParameter.Optional
    }
);

config.Routes.MapHttpRoute(
    name: "Multiparam2",
    routeTemplate: "api/{controller}/{action}/{param1}/{param2}/{startDate}/{endDate}",
    constraints: new
    {
        startDate = @"(20\d\d-[0-1]?\d-[0-3]?\d)?",
        endDate = @"(20\d\d-[0-1]?\d-[0-3]?\d)?"
    },
    defaults: new
    {
        startDate = RouteParameter.Optional,
        endDate = RouteParameter.Optional
    }
);

Noter que, dans ce cas:

1. les routes pourraient être incompatibles, de sorte qu'ils doivent être enregistrés dans le bon ordre, comme illustré. Si vous vous inscrivez d'abord le Multiparam2 route, il aurait tort gérer une URL comme ceci: http://localhost:1179/api/test/testaction/1/2014-12-12/2015-1-1, avec param1=1; param2="2014-12-12"; startDate="2015-1-1". (Vous pouvez éviter cela avec une contrainte supplémentaire sur param2 qui accepte uniquement les nombres, comme param2=@"\d+")
2. l'action doit avoir des valeurs par défaut pour startDate et endDate.

Conclusions

Vous pouvez gérer les paramètres par défaut dans différentes positions avec soin:

• l'enregistrement d'itinéraires dans le bon ordre
• définir les paramètres par défaut de la route, et aussi les valeurs par défaut dans le contrôleur de l'action
• contraintes d'utilisation

Si vous prévoyez attentivement la façon dont vos itinéraires ressembler, vous pouvez obtenir ce dont vous avez besoin avec un peu de routes et des paramètres optionnels.

OriginalL'auteur JotaBe