Cách xây dựng API REST lấy một mảng id cho các tài nguyên

Tôi đang xây dựng một API REST cho dự án của mình. API để nhận INFO của một người dùng nhất định là:

api.com/users/[USER-ID]

Tôi cũng muốn cho phép khách hàng chuyển vào danh sách ID người dùng. Làm cách nào tôi có thể xây dựng API để nó RESTful và đưa vào danh sách ID người dùng?

Nếu bạn đang chuyển tất cả các tham số của mình trên URL, thì có lẽ các giá trị được phân tách bằng dấu phẩy sẽ là lựa chọn tốt nhất. Sau đó, bạn sẽ có một mẫu URL như sau:

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, các cuộc gọi trên có vẻ không RESTful, tuy nhiên đây là cách giải quyết nhanh chóng và hiệu quả (y). Nhưng độ dài của URL bị giới hạn bởi máy chủ web, ví dụ như tomcat .

RESTful nỗ lực:

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

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

Máy chủ sẽ trả lời URI của tài nguyên nhiệm vụ lô mới được tạo .

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

Giờ đây, khách hàng có thể tìm nạp phản hồi hàng loạt hoặc tiến trình tác vụ bằng cách bỏ phiếu

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

Đây là cách những người khác đã cố gắng giải quyết vấn đề này:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju

Tôi tìm thấy một cách khác để làm điều tương tự bằng cách sử dụng @PathParam. Đây là mẫu mã.

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

Gọi cho dịch vụ bằng cách sử dụng url sau.

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

Ở đâu

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

Tôi thích cách tiếp cận này nhiều nhất: -

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

Cách chính xác là

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

hoặc là

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

Đây là cách giá đỡ thực hiện nó. Đây là cách php thực hiện nó. Đây là cách nút cũng thực hiện nó ...

Bạn có thể xây dựng một API Rest hoặc một dự án còn lại bằng cách sử dụng ASP.NET MVC và trả về dữ liệu dưới dạng JSON. Một chức năng điều khiển ví dụ sẽ là:

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

Sau đó, bạn chỉ cần gọi hàm GetUsers thông qua một hàm AJAX thông thường cung cấp mảng Id (trong trường hợp này tôi đang sử dụng jQuery stringify để gửi mảng dưới dạng chuỗi và phi vật chất hóa nó trở lại trong bộ điều khiển nhưng bạn chỉ có thể gửi mảng int và nhận nó như một mảng int trong bộ điều khiển). Tôi đã xây dựng toàn bộ API Restful bằng cách sử dụng ASP.NET MVC trả về dữ liệu dưới dạng json tên miền chéo và có thể được sử dụng từ bất kỳ ứng dụng nào. Tất nhiên nếu bạn có thể sử dụng 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"
            });
    }