Como construir uma API REST que leva uma série de ids para os recursos

Estou construindo uma API REST para meu projeto. A API para obter as INFORMAÇÕES de um determinado usuário é:

api.com/users/[USER-ID]

Também gostaria de permitir que o cliente passe uma lista de IDs de usuário. Como posso construir a API de modo que seja RESTful e tenha uma lista de IDs de usuário?

Se você estiver passando todos os seus parâmetros no URL, provavelmente valores separados por vírgulas seriam a melhor escolha. Então você teria um modelo de URL como o seguinte:

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, as chamadas acima não parecem RESTful, no entanto, essas são soluções alternativas rápidas e eficientes (y). Mas o comprimento da URL é limitado pelo servidor da web, por exemplo, tomcat .

Tentativa RESTful:

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

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

O servidor responderá ao URI do recurso batchtask recém-criado .

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

Agora o cliente pode buscar a resposta em lote ou o progresso da tarefa por meio de sondagem

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

Esta é a forma como outras pessoas tentaram resolver este problema:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Encontro outra maneira de fazer a mesma coisa usando @PathParam. Aqui está o exemplo de código.

@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.
}

Ligue para o serviço usando o seguinte url.

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

Onde

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

Por mais que eu prefira essa abordagem: -

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

A maneira correta é

    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

É assim que o rack faz. É assim que o php faz. É assim que o node também faz ...

Você pode construir uma API Rest ou um projeto restful usando ASP.NET MVC e retornar dados como JSON. Um exemplo de função de controlador seria:

        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));
        }

Em seguida, basta chamar a função GetUsers por meio de uma função AJAX regular fornecendo o array de Ids (neste caso, estou usando o jQuery stringify para enviar o array como string e desmaterializá-lo de volta no controlador, mas você pode apenas enviar o array de ints e receber como uma matriz de int no controlador). Eu construí uma API Restful inteira usando ASP.NET MVC que retorna os dados como json de domínio cruzado e que pode ser usada a partir de qualquer aplicativo. Isso, claro, se você puder usar a 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"
            });
    }