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

Question

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

api.com/users/[USER-ID] 

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

Answer 1

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

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

Answer 2

Вы можете создать API Rest или успокоительный проект с использованием 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 и получить его в виде массива 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" 
      }); 
    } 

Answer 3

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

Позвоните в сервис, используя следующий адрес.

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 

Answer 4

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

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 

Это как rack. Вот как это делается php. Это как узел делает это, а также ...

Answer 5

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

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

RESTful попытка:

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

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

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

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

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

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

---

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

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju