So erstellen Sie eine REST-API, die ein Array von IDs für die Ressourcen verwendet

Ich erstelle eine REST-API für mein Projekt. Die API zum Abrufen der INFO eines bestimmten Benutzers lautet:

api.com/users/[USER-ID]

Ich möchte dem Client auch erlauben, eine Liste von Benutzer-IDs zu übergeben. Wie kann ich die API so erstellen, dass sie REST-fähig ist und eine Liste von Benutzer-IDs enthält?

Wenn Sie alle Ihre Parameter an die URL übergeben, sind wahrscheinlich durch Kommas getrennte Werte die beste Wahl. Dann hätten Sie eine URL-Vorlage wie die folgende:

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, obige Aufrufe sehen nicht RESTful aus, dies sind jedoch schnelle und effiziente Problemumgehungen (y). Die Länge der URL ist jedoch durch den Webserver begrenzt, z . B. Tomcat .

RESTful Versuch:

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

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

Der Server antwortet auf den URI der neu erstellten Batchtask- Ressource.

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

Jetzt kann der Client die Stapelantwort oder den Aufgabenfortschritt durch Abrufen abrufen

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

So haben andere versucht , dieses Problem zu lösen:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Ich finde einen anderen Weg, dasselbe zu tun, indem ich benutze @PathParam. Hier ist das Codebeispiel.

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

Rufen Sie den Dienst unter Verwendung der folgenden URL an.

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

wo

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

So sehr ich diesen Ansatz bevorzuge:

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

Der richtige Weg ist

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

oder

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

So macht es das Rack . So macht es PHP . So macht es auch der Knoten ...

Sie können mit ASP.NET MVC eine Rest-API oder ein Restful-Projekt erstellen und Daten als JSON zurückgeben. Eine beispielhafte Steuerungsfunktion wäre:

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

Dann rufen Sie einfach die GetUsers-Funktion über eine reguläre AJAX-Funktion auf, die das Array von IDs bereitstellt (in diesem Fall verwende ich jQuery stringify, um das Array als Zeichenfolge zu senden und es im Controller wieder zu entmaterialisieren, aber Sie können einfach das Array von Ints senden und empfangen es als Array von Ints im Controller). Ich habe mit ASP.NET MVC eine vollständige Restful-API erstellt, die die Daten als domänenübergreifendes JSON zurückgibt und von jeder App aus verwendet werden kann. Das natürlich, wenn Sie ASP.NET MVC verwenden können.

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