How to construct a REST API that takes an array of id s for the resources

Question

I am building a REST API for my project  The API for getting a given user s INFO is   api com users  USER-ID    I would like to also allow the client to pass in a list of user IDs  How can I construct the API so that it is RESTful and takes in a list of user ID s

User · Answer

If you are passing all your parameters on the URL  then probably comma separated values would be the best choice  Then you would have an URL template like the following   api com users id id1 id2 id3 id4 id5

User · Answer

You can build a Rest API or a restful project using ASP NET MVC and return data as a JSON  An example controller function would be           public JsonpResult GetUsers string userIds                       var values   JsonConvert DeserializeObject lt List lt int gt  gt  userIds                var users    userRepository GetAllUsersByIds userIds                var collection   users Select user   gt  new   id   user Id  fullname   user FirstName       user LastName                 var result   new   users   collection                 return this Jsonp result                     public IQueryable lt User gt  GetAllUsersByIds List lt int gt  ids                        return  db Users Where c  gt  ids Contains c Id                Then you just call the GetUsers function via a regular AJAX function supplying the array of Ids in this case I am using jQuery stringify to send the array as string and dematerialize it back in the controller but you can just send the array of ints and receive it as an array of int s in the controller   I ve build an entire Restful API using ASP NET MVC that returns the data as cross domain json and that can be used from any app  That of course if you can use ASP NET MVC    function GetUsers                    var link     lt    ResolveUrl       gt 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

User · Answer

I find another way of doing the same thing by using  PathParam  Here is the code sample    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      Call the service by using following  url   http   localhost 8080 MyServices resources cm data xml 12 13 56 76   where  http   localhost 8080  War File Name   Servlet Mapping   Class Path  data xml 12 13 56 76

User · Answer

As much as I prefer this approach -       api com users id id1 id2 id3 id4 id5   The correct way is      api com users ids   id1 amp ids   id2 amp ids   id3 amp ids   id4 amp ids   id5   or      api com users ids id1 amp ids id2 amp ids id3 amp ids id4 amp ids id5   This is how rack does it  This is how php does it  This is how node does it as well

User · Answer

api com users id id1 id2 id3 id4 id5  api com users ids   id1 amp ids   id2 amp ids   id3 amp ids   id4 amp ids   id5   IMO  above calls does not looks RESTful  however these are quick and efficient workaround  y   But length of the URL is limited by webserver  eg tomcat    RESTful attempt   POST http   example com api batchtask                   method    GET         headers               url     users id1                     method    GET         headers               url     users id2               Server will reply URI of newly created batchtask resource   201 Created Location   http   example com api batchtask 1254    Now client can fetch batch response or task progress by polling  GET http   example com api batchtask 1254    This is how others attempted to solve this issue    Google Drive Facebook Microsoft Subbu Allamaraju

[api] How to construct a REST API that takes an array of id's for the resources

Examples related to api

Examples related to rest