Comment construire une API REST qui prend un tableau d'identifiants pour les ressources

Je construis une API REST pour mon projet. L'API pour obtenir l'INFO d'un utilisateur donné est:

api.com/users/[USER-ID]

Je voudrais également permettre au client de transmettre une liste d'identifiants d'utilisateurs. Comment puis-je construire l'API de manière à ce qu'elle soit RESTful et intègre une liste d'ID utilisateur?

Si vous passez tous vos paramètres sur l'URL, des valeurs séparées par des virgules seraient probablement le meilleur choix. Ensuite, vous auriez un modèle d'URL comme le suivant:

api.com/users?id=id1,id2,id3,id4,id5

 api.com/users?id=id1,id2,id3,id4,id5
 api.com/users?ids[]=id1&ids[]=id2&ids[]=id3&ids[]=id4&ids[]=id5

IMO, les appels ci-dessus ne semblent pas RESTful, mais il s'agit d'une solution de contournement rapide et efficace (y). Mais la longueur de l'URL est limitée par le serveur Web, par exemple tomcat .

Tentative de repos:

POST http://example.com/api/batchtask

   [
    {
      method : "GET",
      headers : [..],
      url : "/users/id1"
    },
    {
      method : "GET",
      headers : [..],
      url : "/users/id2"
    }
   ]

Le serveur répondra à l'URI de la ressource batchtask nouvellement créée .

201 Created
Location: "http://example.com/api/batchtask/1254"

Le client peut maintenant récupérer la réponse par lots ou la progression de la tâche en interrogeant

GET http://example.com/api/batchtask/1254

Voici comment d'autres ont tenté de résoudre ce problème:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Je trouve une autre façon de faire la même chose en utilisant @PathParam. Voici l'exemple de code.

@GET
@Path("data/xml/{Ids}")
@Produces("application/xml")
public Object getData(@PathParam("zrssIds") String Ids)
{
  System.out.println("zrssIds = " + Ids);
  //Here you need to use String tokenizer to make the array from the string.
}

Appelez le service en utilisant l'URL suivante.

http://localhost:8080/MyServices/resources/cm/data/xml/12,13,56,76

où

http://localhost:8080/[War File Name]/[Servlet Mapping]/[Class Path]/data/xml/12,13,56,76

Autant que je préfère cette approche: -

    api.com/users?id=id1,id2,id3,id4,id5

La bonne façon est

    api.com/users?ids[]=id1&ids[]=id2&ids[]=id3&ids[]=id4&ids[]=id5

ou

    api.com/users?ids=id1&ids=id2&ids=id3&ids=id4&ids=id5

C'est ainsi que le rack procède. Voici comment php le fait. C'est ainsi que node le fait aussi ...

Vous pouvez créer une API Rest ou un projet reposant à l'aide d'ASP.NET MVC et renvoyer des données sous forme de JSON. Un exemple de fonction de contrôleur serait:

        public JsonpResult GetUsers(string userIds)
        {
           var values = JsonConvert.DeserializeObject<List<int>>(userIds);

            var users = _userRepository.GetAllUsersByIds(userIds);

            var collection = users.Select(user => new { id = user.Id, fullname = user.FirstName +" "+ user.LastName });
            var result = new { users = collection };

            return this.Jsonp(result);
        }
        public IQueryable<User> GetAllUsersByIds(List<int> ids)
        {
            return _db.Users.Where(c=> ids.Contains(c.Id));
        }

Ensuite, vous appelez simplement la fonction GetUsers via une fonction AJAX régulière fournissant le tableau d'ID (dans ce cas, j'utilise jQuery stringify pour envoyer le tableau sous forme de chaîne et le dématérialiser dans le contrôleur, mais vous pouvez simplement envoyer le tableau d'entiers et recevoir comme un tableau d'entiers dans le contrôleur). J'ai construit une API Restful entière à l'aide d'ASP.NET MVC qui renvoie les données sous forme de json interdomaine et qui peut être utilisée à partir de n'importe quelle application. Cela bien sûr si vous pouvez utiliser ASP.NET MVC.

function GetUsers()
    {
           var link = '<%= ResolveUrl("~")%>users?callback=?';
           var userIds = [];
            $('#multiselect :selected').each(function (i, selected) {
                userIds[i] = $(selected).val();
            });

            $.ajax({
                url: link,
                traditional: true,
                data: { 'userIds': JSON.stringify(userIds) },
                dataType: "jsonp",
                jsonpCallback: "refreshUsers"
            });
    }