it-roy-ru.com

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

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

api.com/users/[USER-ID]

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

84
uclajatt

Если вы передаете все свои параметры в URL, то, вероятно, лучшим выбором будут значения, разделенные запятыми. Тогда у вас будет шаблон URL, подобный следующему:

api.com/users?id=id1,id2,id3,id4,id5
83
Florin Dumitrescu
 api.com/users?id=id1,id2,id3,id4,id5
 api.com/users?ids[]=id1&ids[]=id2&ids[]=id3&ids[]=id4&ids[]=id5

IMO, приведенные выше вызовы не выглядят как RESTful, однако это быстрый и эффективный обходной путь (у). Но длина URL-адреса ограничена веб-сервером, например Tomcat

RESTful попытка:

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

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

Сервер ответит на URI вновь созданного ресурса batchtask.

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

Теперь клиент может получить пакетный ответ или ход выполнения задачи путем опроса

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


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

24
Nilesh

Я нахожу другой способ сделать то же самое, используя @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
16
Shuja

Насколько я предпочитаю такой подход: - 

    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 делает это. Вот как это делает узел ...

14
Kyristopher

Вы можете создать 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 в контроллере). Я построил весь 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"
            });
    }
0
Vasile Laur