Як побудувати API REST, який бере масив ідентифікаторів для ресурсів

Я будую API REST для свого проекту. API для отримання інформації про даного користувача:

api.com/users/[USER-ID]

Я також хотів би дозволити клієнту перейти до списку ідентифікаторів користувачів. Як я можу побудувати API так, щоб він був RESTful і містив список ідентифікаторів користувача?

Якщо ви передаєте всі свої параметри за URL-адресою, то, ймовірно, кращі значення будуть розділені комами. Тоді ви матимете шаблон URL-адреси, наприклад:

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, вище дзвінки не виглядають RESTful, однак це швидке та ефективне вирішення (y). Але довжина URL-адреси обмежена веб-сервером, наприклад, tomcat .

Спроба вподобання:

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

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

Сервер відповість URI новоствореного ресурсу пакетної задачі .

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

Тепер клієнт може отримати відповідь партії або хід виконання завдання шляхом опитування

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

Ось як інші намагалися вирішити цю проблему:

• Google Диск
• Facebook
• Microsoft
• Subbu Allamaraju

Я знаходжу інший спосіб зробити те саме, використовуючи @PathParam. Ось зразок коду.

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

Зателефонуйте до служби за допомогою наступної URL-адреси.

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

де

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

Наскільки я віддаю перевагу такому підходу: -

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

Правильний шлях

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

або

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

Ось як це робить стійка . Ось як це робить php . Ось як це і вузол це робить ...

Ви можете побудувати API відпочинку або спокійний проект, використовуючи ASP.NET MVC і повертаючи дані як JSON. Приклад функції контролера:

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

Тоді ви просто зателефонуєте до функції GetUsers за допомогою звичайної функції AJAX, що постачає масив ІД (у цьому випадку я використовую jQuery stringify для надсилання масиву як рядка та дематеріалізації його назад у контролері, але ви можете просто надіслати масив ints та отримати це як масив int's в контролері). Я будую цілий API Restful за допомогою ASP.NET MVC, який повертає дані як міждоменний json, який може бути використаний у будь-якому додатку. Звичайно, якщо ви можете використовувати 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"
            });
    }