Comment transmettre plusieurs paramètres à un GET ASP.Net Web API ?

Question

J'utilise l'API Web MVC4 de .Net pour mettre en œuvre (si tout va bien) une API RESTful. J'ai besoin de passer quelques paramètres au système et de lui faire exécuter une action, puis de retourner une liste d'objets comme résultats. Plus précisément, je dois transmettre deux dates et renvoyer les enregistrements qui se situent entre les deux. Je garde également une trace des enregistrements renvoyés afin que les appels ultérieurs ne soient pas retraités dans le système.

J'ai envisagé plusieurs approches :

1. Sérialiser les paramètres en une seule chaîne JSON et la décortiquer dans l'API. http://forums.asp.net/t/1807316.aspx/1

2. Passez les paramètres dans la chaîne de requête.
   Quelle est la meilleure façon de passer plusieurs paramètres de requête à une api restful ?

3. Définir les paramètres dans la route : api/controller/date1/date2

4. J'utilise un POST qui me permet de passer un objet avec des paramètres.

5. Recherche d'ODATA puisque l'API Web le prend (actuellement) en charge. Je n'ai pas encore fait grand-chose avec ça, donc je ne suis pas très familier avec ça.

Il semble que les bonnes pratiques REST indiquent que lorsque des données sont extraites, il faut utiliser un GET. Cependant, GET doit également être nullipotent (ne produit pas d'effets secondaires), et je me demande si mon implémentation spécifique ne viole pas cela puisque je marque les enregistrements dans le système API, et donc que je produis des effets secondaires.

Cela m'a également conduit à la question de la prise en charge des paramètres variables. Si la liste des paramètres d'entrée change, il serait fastidieux de devoir redéfinir votre itinéraire pour le choix 3 si cela se produit souvent. Et que se passerait-il si les paramètres étaient définis au moment de l'exécution...

Dans tous les cas, pour ma mise en œuvre spécifique, quel choix (le cas échéant) semble le meilleur ?

Answer 1

Je pense que le moyen le plus simple est d'utiliser simplement AttributeRouting .

C'est évident dans votre contrôleur, pourquoi voulez-vous que ce soit dans votre Global ? WebApiConfig fichier ?

Exemple :

    [Route("api/YOURCONTROLLER/{paramOne}/{paramTwo}")]
    public string Get(int paramOne, int paramTwo)
    {
        return "The [Route] with multiple params worked";
    }

El {} Les noms doivent correspondre à vos paramètres.

Aussi simple que cela, maintenant vous avez un GET qui gère les paramètres multiples dans cette instance.

Answer 2

Il suffit d'ajouter une nouvelle route à la WebApiConfig entrées.

Par exemple, pour appeler :

public IEnumerable<SampleObject> Get(int pageNumber, int pageSize) { ..

ajouter :

config.Routes.MapHttpRoute(
    name: "GetPagedData",
    routeTemplate: "api/{controller}/{pageNumber}/{pageSize}"
);

Ajoutez ensuite les paramètres à l'appel HTTP :

GET //<service address>/Api/Data/2/10

Answer 3

Je viens de mettre en œuvre une api RESTfull où j'ai besoin de passer des paramètres. J'ai fait cela en passant les paramètres dans la chaîne de requête dans le même style que celui décrit dans le premier exemple de Mark "api/controller?start=date1&end=date2".

Dans le contrôleur, j'ai utilisé une astuce de Division d'URL en C# ?

// uri: /api/courses
public IEnumerable<Course> Get()
{
    NameValueCollection nvc = HttpUtility.ParseQueryString(Request.RequestUri.Query);
    var system = nvc["System"];
    // BL comes here
    return _courses;
}

Dans mon cas, j'appelais le WebApi via Ajax, comme suit :

$.ajax({
        url: '/api/DbMetaData',
        type: 'GET',
        data: { system : 'My System',
                searchString: '123' },
        dataType: 'json',
        success: function (data) {
                  $.each(data, function (index, v) {
                  alert(index + ': ' + v.name);
                  });
         },
         statusCode: {
                  404: function () {
                       alert('Failed');
                       }
        }
   });

J'espère que cela vous aidera...

Answer 4

J'ai trouvé une excellente solution sur http://habrahabr.ru/post/164945/

public class ResourceQuery
{
   public string Param1 { get; set; }
   public int OptionalParam2 { get; set; }
}

public class SampleResourceController : ApiController
{
    public SampleResourceModel Get([FromUri] ResourceQuery query)
    {
        // action
    }
}

Answer 5

Utilisation de GET o POST est clairement expliqué par @LukLed . En ce qui concerne la façon dont vous pouvez passer les paramètres, je suggérerais d'opter pour la deuxième approche (je ne m'y connais pas bien). ODATA soit).

1. sérialiser les paramètres en une seule chaîne JSON et la décortiquer dans l'API. http://forums.asp.net/t/1807316.aspx/1

Ce n'est pas facile à utiliser y Compatible avec les moteurs de recherche

2. passer les paramètres dans la chaîne de requête. Quelle est la meilleure façon de passer plusieurs paramètres de requête à une api restful ?

C'est l'approche habituellement préférable.

3. définition des paramètres dans la route : api/controller/date1/date2

Ce n'est certainement pas une bonne approche. Cela donne l'impression que quelqu'un date2 est une sous-ressource de date1 et ce n'est pas le cas. Les deux date1 y date2 sont des paramètres de requête et se situent au même niveau.

Dans le cas simple, je suggérerais un URI comme celui-ci,

api/controller?start=date1&end=date2

Personnellement, j'aime le modèle URI ci-dessous, mais dans ce cas, nous devons écrire du code personnalisé pour mapper les paramètres.

api/controller/date1,date2