Как создать REST API, который принимает массив идентификаторов для ресурсов

Я создаю REST API для своего проекта. 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 .

RESTful попытка:

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

Вот как другие пытались решить эту проблему:

• Гугл драйв
• Facebook
• Microsoft
• Суббу Алламараджу

Я нашел другой способ сделать то же самое, используя @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 . Вот как это делает node ...

Вы можете создать Rest 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 для отправки массива в виде строки и дематериализации его обратно в контроллер, но вы можете просто отправить массив целых чисел и получить это как массив int в контроллере). Я создал полный Restful API с использованием 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"
            });
    }