Le routage basé sur le paramètre de chaîne de requête de nom

Je suis en train de configurer le routage dans mon MVC4 WebAPI projet.

Je veux être en mesure de rechercher pour les produits en fonction de leur nom ou de leur type comme suit:

/api/products?name=WidgetX - retourne tous les produits nommés WidgetX
/api/products?type=gadget - retourne tous les produits de type gadget

Les routes sont configurés comme ceci:

config.Routes.MapHttpRoute(
    name: "Get by name",
    routeTemplate: "api/products/{name}",
    defaults: new { controller = "ProductSearchApi", action = "GetProductsByName", name = string.Empty }
);

config.Routes.MapHttpRoute(
    name: "Get by type",
    routeTemplate: "api/products/{type}",
    defaults: new { controller = "ProductSearchApi", action = "GetProductsByType", type = string.Empty }
);

Le problème est que le nom du paramètre de chaîne de requête semble être ignoré si le premier est toujours celui qui est utilisé, quel que soit le nom du paramètre de chaîne de requête.
Comment puis-je modifier mon itinéraire pour y arriver?

InformationsquelleAutor rickythefox | 2012-09-27
  1. 30

    Ce que vous avez besoin est juste un seul itinéraire ci-dessous, car la chaîne de requête n'est pas utilisé en tant que paramètres de routage:

    config.Routes.MapHttpRoute(
    name: "Get Products",
    routeTemplate: "api/products",
    defaults: new { controller = "ProductSearchApi" }
);

    Et, ensuite, de définir deux méthodes comme ci-dessous:

    GetProductsByName(string name)
{}

GetProductsByType(string type)
{}

    Le mécanisme de routage smart assez pour l'acheminement de votre url de votre bonne action basé sur le nom de chaîne de requête si la même chose avec des paramètres d'entrée. Bien sûr, sur toutes les méthodes avec le préfixe sont Get

    Vous pourriez avoir besoin de lire ceci:
    http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-and-action-selection

    InformationsquelleAutor cuongle
  2. 4

    Vous n'avez pas besoin d'inclure vos paramètres de requête dans l'itinéraire. Il ne devrait être qu'une simple carte d'itinéraire pour couvrir les Méthodes du protocole Http sur l'ensemble de vos ApiControllers:

    routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

    Le seul moment où vous devez ajuster les routes de l'est, si vous voulez déplacer un paramètre dans le chemin d'accès réel, que vous ne semblez pas être en train de faire. Ensuite, votre GET http méthode de recherche par deux domaines:

    public IEnumerable<Product> Get(string name, string type){
    //..your code will have to deal with nulls of each parameter
}

    Si vous souhaitez rechercher uniquement par un champ à la fois, alors vous devriez penser à utiliser les différents contrôleurs pour des fins différentes. C'est à dire, un SearchProductByTypeController qui a un seul Get(string type) méthode. La voie serait alors /api/SearchProductByTypeController?type=gadget

    • Merci, parfois, le problème n'est pas dans le code mais dans l'architecture. 😉
    • Ce type de ressource est un SearchProductByTypeController? 😛
    InformationsquelleAutor Nick
  3. 0

    essayez de changer string.Empty pour RouteParameter.Optional

    • RouteParameter me ferait utiliser des url comme /produits/abc, qui serait, bien entendu, de ne pas satisfaire à l'exigence. J'ai besoin d'être en mesure d'utiliser les paramètres de chaîne de requête.
    InformationsquelleAutor hagensoft
  4. 0

    Êtes-vous sûr que les contrôleurs sont ok? Je veux dire, le nom de la params.

        public string GetProductsByName(string name)
    {
        return "Requested name: " + name;
    }

    public string GetProductsByType(string type)
    {
        return "Requested type: " + type;
    }
    InformationsquelleAutor laszlokiss88