एक आरईएसटी एपीआई कैसे बनाया जाए जो संसाधनों के लिए आईडी की सरणी लेता है

Question

मैं अपनी परियोजना के लिए एक आरईएसटी एपीआई बना रहा हूं। उसे किसी उपयोगकर्ता की जानकारी प्राप्त करने के लिए एपीआई है:

api.com/users/[USER-ID] 

मैं भी ग्राहक उपयोगकर्ता आईडी की सूची में पारित करने के लिए अनुमति देने के लिए करना चाहते हैं। मैं एपीआई कैसे बना सकता हूं ताकि यह रीस्टफुल हो और उपयोगकर्ता आईडी की सूची ले सके?

Answer 1

यदि आप यूआरएल पर अपने सभी पैरामीटर पास कर रहे हैं, तो शायद अल्पविराम से अलग मूल्य सबसे अच्छा विकल्प होगा। तो फिर आप निम्नलिखित की तरह एक यूआरएल टेम्प्लेट होगा:

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

Answer 2

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

तो फिर तुम सिर्फ एक नियमित रूप से AJAX समारोह (आईडी की सरणी इस मामले मैं jQuery का उपयोग कर रहा में आपूर्ति के माध्यम से GetUsers फ़ंक्शन को कॉल स्ट्रिंग के रूप में सरणी भेजने के लिए और यह dematerialize को stringify नियंत्रक में वापस लेकिन आप केवल इंक की सरणी भेज सकते हैं और इसे नियंत्रक में int की सरणी के रूप में प्राप्त कर सकते हैं)। मैंने एएसपी.नेट एमवीसी का उपयोग करके एक संपूर्ण रेस्टफॉल एपीआई बनाया है जो डेटा को क्रॉस डोमेन जेसन के रूप में लौटाता है और इसका उपयोग किसी ऐप से किया जा सकता है। निश्चित रूप से यदि आप एएसपी.नेट एमवीसी का उपयोग कर सकते हैं।

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 

IMO, ऊपर कॉल नहीं RESTful हुई, हालांकि यह जल्दी और कुशल वैकल्पिक हल (y) कर रहे हैं लगता है करता है कि कैसे नोड यह रूप में अच्छी तरह से करता है है ...। लेकिन यूआरएल की लंबाई वेबसर्वर द्वारा सीमित है, उदाहरण के लिए 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" 
    } 
    ] 

सर्वर नव निर्मित batchtask संसाधन का यूआरआई उत्तर देगा।

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

अब ग्राहक बैच प्रतिक्रिया या मतदान से कार्य प्रगति प्राप्त कर सके

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

---

यक्ति इस समस्या को हल करने के लिए का प्रयास किया जाता है:

• Google Drive
• Facebook
• Microsoft
• Subbu Allamaraju