Cómo construir una API REST que tome una matriz de id para los recursos

Question

Estoy creando una API REST para mi proyecto. El API para obtener la información de un usuario dado es:

api.com/users/[USER-ID] 

Me gustaría también permitir que el cliente pase en una lista de ID de usuario. ¿Cómo puedo construir la API para que sea RESTful y toma una lista de ID de usuario?

Answer 1

Si está pasando todos sus parámetros en la URL, entonces probablemente los valores separados por comas serían la mejor opción. De allí tendría que tener una plantilla de URL como la siguiente:

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

Answer 2

Se puede construir una API REST o un proyecto reparador con ASP.NET MVC y devolver datos como JSON. Un ejemplo de función del controlador sería:

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

A continuación, sólo llama a la función GetUsers través de una función de AJAX abastecimiento regular la matriz de ID (en este caso estoy usando jQuery stringify para enviar la matriz como cuerda y desmaterializar se de vuelta en el controlador, pero puede enviar la matriz de entradas y recibirla como una matriz de int en el controlador). Construí una API Restful completa utilizando ASP.NET MVC que devuelve los datos como dominio cruzado json y que se pueden usar desde cualquier aplicación. Eso por supuesto si puedes usar 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" 
      }); 
    } 

Answer 3

Otra forma de hacer lo mismo es usar @PathParam. Aquí está la muestra del 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. 
} 

Llama al servicio utilizando la siguiente url.

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

donde

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

Answer 4

Por mucho que yo prefiero este enfoque: -

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

La forma correcta es

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

o

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

Así es como rack lo hace. Así es como lo hace php. Así es como nodo lo hace así ...

Answer 5

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

OMI, llamadas antes mencionadas no parece que va REST, sin embargo, estos son rápida y eficiente solución (y). Pero la longitud de la URL está limitada por el servidor web, por ejemplo, tomcat.

intento REST:

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

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

servidor responderá URI del recién creado batchtask recursos.

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

cliente Ahora puede ir a buscar la respuesta por lotes o progreso de la tarea mediante el sondeo

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

---

Esta es la forma en que otros intentaron para resolver este problema:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju