Cara membuat REST API yang mengambil array id untuk sumber daya

Saya membangun REST API untuk proyek saya. API untuk mendapatkan INFO pengguna tertentu adalah:

api.com/users/[USER-ID]

Saya juga ingin mengizinkan klien untuk memasukkan daftar ID pengguna. Bagaimana cara membangun API sehingga RESTful dan memasukkan daftar ID pengguna?

Jika Anda meneruskan semua parameter Anda di URL, mungkin nilai yang dipisahkan koma akan menjadi pilihan terbaik. Maka Anda akan memiliki template URL seperti berikut:

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, panggilan di atas tidak terlihat tenang, namun ini adalah solusi cepat dan efisien (y). Tapi panjang URL dibatasi oleh webserver, misal tomcat .

Upaya tenang:

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

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

Server akan membalas URI sumber daya batchtask yang baru dibuat .

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

Sekarang klien dapat mengambil respons batch atau kemajuan tugas dengan polling

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

Beginilah upaya orang lain untuk menyelesaikan masalah ini:

• google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Saya menemukan cara lain untuk melakukan hal yang sama dengan menggunakan @PathParam. Ini contoh kodenya.

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

Panggil layanan dengan menggunakan url berikut.

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

dimana

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

Sebanyak saya lebih suka pendekatan ini: -

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

Cara yang benar adalah

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

atau

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

Beginilah rak melakukannya. Beginilah cara php melakukannya. Beginilah cara node melakukannya juga ...

Anda dapat membangun Rest API atau proyek yang tenang menggunakan ASP.NET MVC dan mengembalikan data sebagai JSON. Contoh fungsi pengontrol adalah:

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

Kemudian Anda cukup memanggil fungsi GetUsers melalui fungsi AJAX biasa yang memasok array Id (dalam hal ini saya menggunakan jQuery stringify untuk mengirim array sebagai string dan mendematerialisasikannya kembali ke pengontrol tetapi Anda cukup mengirim array int dan menerima itu sebagai array int di pengontrol). Saya telah membangun seluruh Restful API menggunakan ASP.NET MVC yang mengembalikan data sebagai json lintas domain dan dapat digunakan dari aplikasi apa pun. Itu tentunya jika Anda bisa menggunakan 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"
            });
    }