Come costruire un'API REST che accetta un array di ID per le risorse

Sto creando un'API REST per il mio progetto. L'API per ottenere le INFO di un determinato utente è:

api.com/users/[USER-ID]

Vorrei anche consentire al cliente di passare un elenco di ID utente. Come posso costruire l'API in modo che sia RESTful e includa un elenco di ID utente?

Se stai passando tutti i tuoi parametri sull'URL, probabilmente i valori separati da virgola sarebbero la scelta migliore. Quindi avresti un modello di URL come il seguente:

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, le chiamate di cui sopra non sembrano RESTful, tuttavia si tratta di una soluzione rapida ed efficiente (y). Ma la lunghezza dell'URL è limitata dal server web, ad esempio tomcat .

Tentativo RESTful:

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

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

Il server risponderà all'URI della risorsa batchtask appena creata .

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

Ora il client può recuperare la risposta batch o lo stato di avanzamento dell'attività mediante polling

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

Ecco come altri hanno tentato di risolvere questo problema:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Trovo un altro modo per fare la stessa cosa usando @PathParam. Ecco il codice di esempio.

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

Chiama il servizio utilizzando il seguente URL.

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

dove

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

Per quanto preferisco questo approccio: -

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

Il modo corretto è

    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

Ecco come fa il rack . Ecco come lo fa php . Ecco come lo fa anche node ...

Puoi creare un'API Rest o un progetto riposante usando ASP.NET MVC e restituire i dati come JSON. Una funzione di controller di esempio potrebbe essere:

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

Quindi chiami semplicemente la funzione GetUsers tramite una normale funzione AJAX che fornisce l'array di ID (in questo caso sto usando jQuery stringify per inviare l'array come stringa e dematerializzarlo di nuovo nel controller ma puoi semplicemente inviare l'array di int e ricevere come un array di int nel controller). Ho creato un'intera API Restful utilizzando ASP.NET MVC che restituisce i dati come json tra domini e che può essere utilizzato da qualsiasi app. Ovviamente se puoi usare 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"
            });
    }