Jak skonstruować REST API, które pobiera tablicę identyfikatorów dla zasobów

Buduję REST API dla mojego projektu. API do pobierania INFO danego użytkownika to:

api.com/users/[USER-ID]

Chciałbym również umożliwić klientowi przekazanie listy identyfikatorów użytkowników. Jak mogę zbudować interfejs API, aby był zgodny ze specyfikacją REST i przyjmował listę identyfikatorów użytkowników?

Jeśli przekazujesz wszystkie parametry w adresie URL, prawdopodobnie najlepszym wyborem będą wartości oddzielone przecinkami. Wtedy miałbyś szablon adresu URL podobny do następującego:

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, powyższe wywołania nie wyglądają na RESTful, jednak są to szybkie i wydajne obejście (y). Jednak długość adresu URL jest ograniczona przez serwer WWW, np . Tomcat .

RESTful próba:

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

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

Serwer odpowie na URI nowo utworzonego zasobu zadania wsadowego .

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

Teraz klient może pobrać odpowiedź wsadową lub postęp zadania przez odpytywanie

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

Oto jak inni próbowali rozwiązać ten problem:

• dysk Google
• Facebook
• Microsoft
• Subbu Allamaraju

Znalazłem inny sposób zrobienia tego samego, używając @PathParam. Oto przykładowy kod.

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

Zadzwoń do usługi, używając następującego adresu URL.

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

gdzie

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

O ile wolę to podejście: -

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

Właściwy sposób to

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

lub

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

Tak to robi rack . Tak to robi php . Tak też robi to node ...

Możesz zbudować Rest API lub spokojny projekt przy użyciu ASP.NET MVC i zwrócić dane jako JSON. Przykładowa funkcja kontrolera to:

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

Następnie po prostu wywołujesz funkcję GetUsers za pośrednictwem zwykłej funkcji AJAX dostarczającej tablicę identyfikatorów (w tym przypadku używam jQuery stringify, aby wysłać tablicę jako ciąg znaków i zdematerializować ją z powrotem w kontrolerze, ale możesz po prostu wysłać tablicę int i odebrać to jako tablica int w kontrolerze). Zbudowałem cały Restful API przy użyciu ASP.NET MVC, który zwraca dane jako json międzydomenowy i może być używany z dowolnej aplikacji. Oczywiście, jeśli możesz używać 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"
            });
    }