नमस्ते।
गर्मियों में, फ्रेमवर्क का एक नया संस्करण जारी किया गया था, लेकिन हाल ही में इसके साथ काम करना संभव था। नए संस्करण में बहुत सारी उपयोगी चीजें शामिल हैं, उनमें से एक के बारे में, अर्थात् ApiController, मैं आज के बारे में बात करना चाहूंगा।
उनके लिए धन्यवाद, बिना किसी अतिरिक्त प्रयास के RESTFull Api करना संभव हो गया। एक छोटे से उदाहरण में, एक ही समय में, हम ओडटा के साथ काम करने का विश्लेषण करेंगे।

एक नया ASP MVC 4 खाली प्रोजेक्ट बनाएँ। उदाहरण के लिए, एक नियंत्रक बनाएं जो विषयों के साथ काम करने के लिए कार्यक्षमता को लागू करेगा। सबसे पहले, एक साधारण मॉडल जोड़ें:

public class Topic { public int Id { get; set; } public string Title { get; set; } } 

एक नया नियंत्रक जोड़ें, इसे ApiController से विरासत में मिला , अब तक बिना किसी कार्रवाई के:

 public class TopicController : ApiController { } 

अब हमारे नियंत्रक पर उपलब्ध है: लोकलहोस्ट / एपीआई / विषय । यदि हम इसका पालन करते हैं, तो हमें यह कहते हुए एक संदेश प्राप्त होगा कि हमारे नियंत्रक में कोई भी कार्य नहीं मिला है जो एक GET अनुरोध के जवाब को लागू करता है। इसलिए इसे हमारे कंट्रोलर में जोड़ें:

 public class TopicController : ApiController { public ICollection<Topic> Get() { return new Collection<Topic> { new Topic { Id = 1, Title = " 1"}, new Topic { Id = 2, Title = " 2"} }; } } 

यदि हम लोकलहोस्ट / एपीआई / विषय के लिए अनुरोध करते हैं , तो हमें निम्नलिखित प्रतिक्रिया मिलती है:

 <ArrayOfTopicModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApiControllerTutorial.Models"> <TopicModel> <Id>1</Id> <Title> 1</Title> </TopicModel> <TopicModel> <Id>2</Id> <Title> 2</Title> </TopicModel> </ArrayOfTopicModel> 

XML प्रारूप में उत्तर क्यों है? क्योंकि यदि हमने अनुरोध में सामग्री-प्रकार निर्दिष्ट नहीं किया है, तो धारावाहिक डिफ़ॉल्ट रूप से XML को हमारे पास लौटा देगा। आइए, JSON प्रारूप में आते हैं। ऐसा करने के लिए, आप क्रोमियम - रीस्ट कंसोल के लिए सुविधाजनक एप्लिकेशन का उपयोग कर सकते हैं (मैं अन्य ब्राउज़रों के लिए समान प्लग-इन / एक्सटेंशन की मदद के लिए आभारी रहूंगा)। हम सामग्री-प्रकार में "json" निर्दिष्ट करते हैं और प्राप्त करते हैं:

 [{"Id":1,"Title":" 1"},{"Id":2,"Title":" 2"}] 

हमें विषयों का संग्रह मिला। किसी एक विषय को उसके पहचानकर्ता द्वारा प्राप्त करने के लिए नियंत्रक में एक नई क्रिया जोड़ें:

 public Topic Get(int id) { return new Topic { Id = id, Title = String.Format(" {0}", id) }; } 

लोकलहोस्ट / एपीआई / विषय / 5 के लिए एक अनुरोध निम्नलिखित उत्तर देगा:

 {"Id":5,"Title":" 5"} 

हमारे विषय को जोड़ने के लिए एक क्रिया जोड़ें:

 public string Put(Topic model) { return String.Format(" '{0}' !", model.Title); } 

और स्थानीय अनुरोध / एपीआई / विषय के लिए निम्नलिखित अनुरोध भेजें:

 {'Title':' '} 

हम अनुरोध में आवश्यक मापदंडों को भी निर्दिष्ट करेंगे: अनुरोध विधि - PUT और सामग्री प्रकार - एप्लिकेशन / json (इस सामग्री प्रकार को मेरे द्वारा बताए गए के साथ भ्रमित न करें। यह सामग्री हेडर में इंगित किया गया है ताकि बाइंडर को पता चल जाए कि डेटा किस प्रारूप में आया था। , और उन विषयों का अनुरोध करने के लिए जिन्हें हमने सीरियल के लिए एक्सेप्ट में कंटेंट टाइप निर्दिष्ट किया था)। और हम जवाब में:

 " ' ' !" 

रिटर्न वैल्यू की बात की जा रही है। हमारे मामले में, मैंने एक संदेश के साथ एक स्ट्रिंग लौटा दी। आप ऑपरेशन की सफलता / विफलता के आधार पर एक HttpResponseMessage भी लौटा सकते हैं और प्रतिक्रिया कोड में हेरफेर कर सकते हैं:

 public HttpResponseMessage Put(Topic model) { if(String.IsNullOrEmpty(model.Title)) return new HttpResponseMessage(HttpStatusCode.BadRequest); /* */ return new HttpResponseMessage(HttpStatusCode.Created); } 

मैं POST विधि के लिए कार्रवाई का वर्णन नहीं करूंगा, क्योंकि PUT से कोई अंतर नहीं हैं। अंतिम DELETE क्रिया जोड़ें:

 public string Delete(int id) { return String.Format(" {0} !", id); } 

मार्ग

लेकिन क्या होगा अगर हम बिना विधि समर्थन के, एक साधारण एपीआई प्रदान करने के लिए अपने नियंत्रक का उपयोग करना चाहते हैं?
दो क्रियाओं के साथ एक नया नियंत्रक जोड़ें:

 public class TestRouteController : ApiController { public string GetTopic(int id) { return String.Format("Topic {0}", id); } public string GetComment(int id) { return String.Format("Comment {0}", id); } } 

यदि हम लोकलहोस्ट / एपीआई / टेस्ट्राउट / 5 के लिए एक अनुरोध भेजते हैं, तो हमें एक त्रुटि मिलती है: कई कार्य पाए गए जो अनुरोध से मेल खाते हैं । यह इस तथ्य के कारण है कि चयनकर्ता को यह नहीं पता है कि क्या चुनना है। आइए WebApiConfig.cs खोलें और वहां दिए गए मार्ग को देखें:

 public static void Register(HttpConfiguration config) { config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); } 

जैसा कि आप देख सकते हैं, हमने टेम्प्लेट में कंट्रोलर के लिए एक्शन डेफिनिशन को परिभाषित नहीं किया है। अनुरोध विधि के आधार पर आवश्यक नियंत्रक क्रिया का चयन किया जाता है। नीचे एक और मार्ग जोड़ें:

 config.Routes.MapHttpRoute( name: "DefaultApiWithAction", routeTemplate: "api/{controller}/{action}/{id}", defaults: new { id = RouteParameter.Optional } ); 

उसके बाद, यदि हम अपने नियंत्रक से आवश्यक कार्रवाई के प्रत्यक्ष संकेत के साथ अनुरोध करते हैं ( लोकलहोस्ट / एपीआई / टेस्ट्राउट / गेटटॉपिक / 5 ), तो हमें एक प्रतिक्रिया मिलेगी। या आप ActionName विशेषता का उपयोग करके कार्रवाई के लिए वांछित मार्ग सेट कर सकते हैं:

 [ActionName("topic")] public string GetTopic(int id) { return String.Format("Topic {0}", id); } 

अब आप लोकलहोस्ट / एपीआई / टेस्टाउट / विषय / 5 का अनुरोध कर सकते हैं

OData

जैसा कि आप पहले ही देख चुके हैं, नियंत्रक द्वारा किए गए कार्यों में मनमानी वस्तुओं या वस्तुओं के संग्रह को वापस किया जा सकता है और उन्हें सफलतापूर्वक सीरियल किया जाएगा। पहले, हमें एक ActionResult वापस करने की आवश्यकता थी, और इससे पहले, मैन्युअल रूप से हमारे डेटा को क्रमबद्ध करें। इस संबंध में, एक और दिलचस्प अवसर खुलता है। पैकेज मैनेजर का उपयोग करके पहले ओडटा ( नूगेट ) स्थापित करें:

PM> इंस्टॉल-पैकेज Microsoft.AspNet.WebApi.OData -Pre

एक नया नियंत्रक जोड़ें:

 public class OdataController : ApiController { [Queryable] public IQueryable<Topic> Get() { return new EnumerableQuery<Topic>( new Collection<Topic> { new Topic{ Id = 1, Title = "1"}, new Topic{ Id = 2, Title = "2"}, new Topic{ Id = 3, Title = "3"}, new Topic{ Id = 4, Title = "4"}, new Topic{ Id = 5, Title = "5"} }); } } 

आइए लोकलहोस्ट / एपी / ओडेटा से अनुरोध करें:

 [{"Id":1,"Title":"1"},{"Id":2,"Title":"2"},{"Id":3,"Title":"3"},{"Id":4,"Title":"4"},{"Id":5,"Title":"5"}] 

कुछ भी आश्चर्य नहीं हुआ। लेकिन चलो हमारे नियंत्रक की विधि प्राप्त करें। यह IQueryable को लौटाता है और [Queryable] विशेषता के साथ चिह्नित किया जाता है, जिसका अर्थ है कि आप क्वेरी में सीधे OData का उपयोग करके हमारे संग्रह में अतिरिक्त क्वेरी लागू कर सकते हैं। आइए विभिन्न मापदंडों के साथ कुछ प्रश्न करें और उत्तर देखें:

जांच	जवाब है
लोकलहोस्ट / एपी / ओडाटा	[{"Id": 1, "शीर्षक": "1"}, {"Id": 2, "शीर्षक": "2"}, {"Id": 3, "शीर्षक": "3"}, {"Id": 4, "शीर्षक": "4"}, {"Id": 5, "शीर्षक": "5"}]
लोकलहोस्ट / एपी / ओडेटा ? $ स्किप = 2	[{"Id": 3, "शीर्षक": "3"}, {"Id": 4, "शीर्षक": "4"}, {"Id": 5, "शीर्षक": "5"}]
लोकलहोस्ट / एपी / ओडाटा ? $ स्किप = 1 और $ टॉप = 2	[{"Id": 2, "शीर्षक": "2"}, {"Id": 3, "शीर्षक": "3"}]
लोकलहोस्ट / एपी / ओडेटा ? $ फ़िल्टर = (आईडी gt 1) और (आईडी लेफ्ट ५)	[{"Id": 2, "शीर्षक": "2"}, {"Id": 3, "शीर्षक": "3"}, {"Id": 4, "शीर्षक": "4"}]
लोकलहोस्ट / एपी / ओडाटा ? $ फ़िल्टर = (आईडी gt 1) और (आईडी लेफ्टिनेंट ५) और $ ऑर्डरबी = आईडीसी	[{"Id": 4, "शीर्षक": "4"}, {"Id": 3, "शीर्षक": "3"}, {"Id": 2, "शीर्षक": "2"}]

जादू, है ना?

---

नियंत्रकों को फ़ॉर्म सबमिट करना: http://www.asp.net/web-api/overview/working-with-http/sending-html-form-data,-part-1#sending_complex_types
OData के बारे में सभी: http://msdn.microsoft.com/en-us/library/ff478141.aspx
पुरालेख परियोजना के साथ: yadi.sk/d/k2KaG0cL1fXhA