👩🏽‍⚕️ 🗂️ 🔖 काचे में एक प्रतिष्ठित वेब एपीआई का निर्माण 🖤 🚴🏾 🆒

InterSystems Caché अन्य सहायता का परिचय देता है। Habré पर REST ने पहले से ही एक से अधिक बार क्या लिखा । संक्षेप में, यह एक RESTful वेब API निर्माण पैटर्न है, और इसमें निम्नलिखित गुण हैं:

क्लाइंट और सर्वर का पृथक्करण,
राज्य (स्टेटलेस) के बावजूद,
कैश्ड और स्तरित वास्तुकला,
एकल इंटरफ़ेस
RESTful वेब API के सभी अनुरोधों में एप्लिकेशन और निजी उप-सूचियों के रूट URL शामिल हैं,
HTTP पर CRUD - HTTP मेथड GET, PUT, POST, DELETE (RESTful web API)।

एक सामान्य REST एप्लिकेशन कुछ इस तरह दिखता है: एक रूट URL (http://example.com/resources/) और चाइल्ड URL (http://example.com/resources/item17) है, जिसे हम HTTP के माध्यम से उपयोग करते हुए उपयोग करते हैं। GET, PUT, POST, DELETE के तरीके। नीचे एक तत्व और संग्रह के साथ विधियों और कार्यों की एक तालिका है:

विधि	आइटम संग्रह अनुरोध example.com/resources	एकल आइटम अनुरोध example.com/resources/itemID
प्राप्त	संभवत: संग्रह आइटम URIs की एक सूची प्राप्त करें। सूचना	सभी आइटम जानकारी प्राप्त करें
PUT	मौजूदा संग्रह को एक नए के साथ बदलें	मौजूदा आइटम को नए से बदलें
पोस्ट	एक नया संग्रह आइटम बनाएँ	आमतौर पर इस्तेमाल नहीं किया जाता है
हटाएँ	संपूर्ण संग्रह हटाएं	संग्रह आइटम हटाएं

काचे के बारे में क्या?

Caché DBMS में, REST का समर्थन संस्करण 2014.1 के बाद से दिखाई देता है - यह संस्करण अभी भी InterSystems Campus के भागीदारों और विश्वविद्यालयों के लिए एक फ़ील्ड परीक्षण संस्करण के रूप में उपलब्ध है। REST एप्लिकेशन बनाने के लिए, आपको Caché वेब एप्लिकेशन की सेटिंग में एक ब्रोकर वर्ग को परिभाषित करने की आवश्यकता होती है, जो इन एक्सटेंशनों का अनुरोध करते समय बेस URL के संभावित एक्सटेंशन और एप्लिकेशन की संबंधित क्रियाओं को इंगित करता है।
ब्रोकर वर्ग को% CSP.REST क्लास का वंशज बनाया जाता है। इसके अलावा, इसमें एप्लिकेशन के URL पथ (उदाहरण के लिए, example.com/resources/ID - GET) का एक मानचित्र होता है, और प्रत्येक URL को एक Caché वर्ग विधि दी जाती है जो सभी कार्य करेगी।
पथ मानचित्र डेटा प्राप्त करने या सर्वर पर डेटा को संशोधित करने के लिए किसी एप्लिकेशन तक पहुंचने के लिए सभी संभावित URL की एक सूची है।

Caché में REST वेब अनुप्रयोग का नमूना फ़्लोचार्ट

व्यापार के लिए

सबसे पहले, Dispatch Class REST.Broker के साथ / बाकी वेब एप्लिकेशन बनाएं

सिस्टम प्रबंधन पोर्टल (पोर्टल) में:
- पोर्टल → सिस्टम एडमिनिस्ट्रेशन → सुरक्षा → एप्लीकेशन → वेब एप्लीकेशन
- नया वेब अनुप्रयोग बनाएँ बटन पर क्लिक करें
वेब एप्लिकेशन संपादन पृष्ठ पर, निम्नलिखित फ़ील्ड भरें (अन्य फ़ील्ड अपरिवर्तित रहें):
- नाम: / आराम (आवश्यक स्लैश)
- क्षेत्र: USER
- डिस्पैच क्लास: REST.Broker (स्ट्रिंग केस सेंसिटिव है)
सहेजें पर क्लिक करें

अब हमें REST.Broker क्लास बनाने की आवश्यकता है - भविष्य के वेब API का पाथ मैप। स्टूडियो खोलें

USER क्षेत्र पर जाएं
Ctrl + N या मेनू से फ़ाइल: नया दबाकर एक नया REST.Broker वर्ग बनाएं।
जनरल टैब चुनें और वहां क्लास कैच करें
वर्ग विज़ार्ड में:
- पैकेज का नाम दर्ज करें: REST
- वर्ग नाम दर्ज करें: ब्रोकर
- अगला क्लिक करें
क्लास टाइप विंडो में:
- एक्सटेंशन बटन पर क्लिक करें
- पूर्वज वर्ग का नाम: % CSP.REST
- समाप्त पर क्लिक करें

हम दलाल वर्ग में पथ मानचित्र और हैंडलर विधि लिखते हैं

कक्षा REST.Broker% CSP.REST का विस्तार करता है
{
XData UrlMap
{
< मार्गों >
< मार्ग Url = "/ परीक्षण" विधि = "GET" कॉल = "परीक्षण" />
</ मार्गों >
}
ClassMethod टेस्ट () % स्थिति के रूप में
{
& html < यह काम करता है! >
$ $ $ $ ठीक है
}
}

XData UrlMap पथ मानचित्र में, URL / परीक्षण का उपयोग करते समय, REST.Broker वर्ग का परीक्षण विधि कहा जाता है। यदि आप अन्य वर्गों के तरीकों को कहते हैं, तो आपको कॉल में वर्ग का नाम भी बताना होगा

पते पर http: // <सर्वर का पता> / बाकी / परीक्षण शिलालेख "वर्क्स!" प्रदर्शित किया जाना चाहिए
सबसे सरल Restful web API तैयार है।

डेटा की तैयारी

अधिक जटिल उदाहरण के लिए, हमें डेटा की आवश्यकता है। एक वर्ग Data.Company बनाएँ

वर्ग विज़ार्ड में:
- पैकेज का नाम: डेटा
- वर्ग का नाम: कंपनी
- अगला क्लिक करें।
क्लास टाइप विंडो में:
- Persistent Button पर क्लिक करें
- अगला क्लिक करें
- XML सक्षम का चयन करें
- डेटा जनसंख्या विकल्प चुनें।
समाप्त पर क्लिक करें

एक नाम संपत्ति बनाएँ - प्रत्येक कंपनी का एक नाम होना चाहिए

वर्ग डेटा। विस्तार का विस्तार ( % स्थायी , % आबादी , % XML.Adaptor )
{
% स्ट्रिंग के रूप में संपत्ति का नाम ( POPSPEC = "कंपनी ()" );
}

POPSPEC = "कंपनी ()" - हम परीक्षण डेटा जनरेटर को बताते हैं कि हम उससे क्या चाहते हैं, अन्यथा वह हमें यहां के लोगों का नाम देगा।

टर्मिनल में कमांड का उपयोग करके परीक्षण डेटा के साथ वर्ग भरें: w ## वर्ग ( Data.Company )। आबाद (10)

सर्वर साइड

रिटर्न ऑपरेशन (HTTP - GET) के CRUD को प्रदर्शित करने के लिए, हम RESTful सेवा के अनुरोधों के लिए JSON प्रतिक्रियाओं को उत्पन्न करने के कार्यों के लिए एक नया REST.JSON क्लास बनाएंगे।

REST.JSON क्लास बनाएँ

वर्ग विज़ार्ड में:
- पैकेज का नाम: बाकी
- वर्ग का नाम: JSON
- अगला क्लिक करें।
क्लास टाइप विंडो में:
- एक्सटेंशन बटन पर क्लिक करें
- पूर्वज वर्ग का नाम: % आधार
समाप्त पर क्लिक करें

शुरुआत करने के लिए, हम एक विधि लिखेंगे जो JSON को उनकी सभी संपत्तियों वाली कंपनियों की सूची में वापस लौटाएगी

ClassMethod GetAllCompanies () % स्थिति के रूप में
{

सेट सेंट = $ $ $ ओके
कोशिश करो {
## कक्षा ( % ZEN.Auxiliary.jsonSQLProvider ) करें। % WriteJSONFromSQL (, "Data.Company से" का चयन करें )
} पूर्व कैच {
सेट सेंट = पूर्व । AsStatus ()
}
सेंट छोड़ दिया
}

यहां एकमात्र दिलचस्प विधि jsonSQLProvider वर्ग विधि है - यह वर्तमान डिवाइस पर JSON प्रारूप में SQL क्वेरी के परिणाम को प्रदर्शित करता है। पैरामीटर सूची में अल्पविराम पर ध्यान दें, इसकी आवश्यकता है, क्योंकि पहला पैरामीटर क्लाइंट-साइड वैरिएबल का वैकल्पिक जावास्क्रिप्ट नाम है।

हमने JSON में डेटा देना सीखा, लेकिन ब्रोकर को इसके बारे में पता नहीं है।

REST.Broker पथ मानचित्र में एक पथ जोड़ें ताकि यह पता चले

मार्ग यूआरएल = "/ json / कंपनियाँ" विधि = "GET" कॉल = "REST.JSON: GetAllCompanies" />

हो गया! अब http: // <server address> / rest / json / companies में आपको एक उदाहरण JSON में कंपनियों की सूची मिलेगी।

सर्वर - ग्राहक!

और क्लाइंट की तरफ, हम JSON को आंख को प्रसन्न करने वाली चीज में बदल देंगे। ऐसा करने के लिए, हम AngularJS MVC JS फ्रेमवर्क का उपयोग करते हैं।

लेकिन सबसे पहले, एक नया CSP पेज बनाएं

Caché Studio में, Ctrl + N दबाकर या मेनू से एक नया CSP पेज बनाएँ: फ़ाइल → नया
CSP फ़ाइल टैब चुनें
Caché Server पेज का चयन करें और ठीक पर क्लिक करें।
Csp / user फोल्डर में बने पेज को rest.csp नाम से सेव करें

हम सर्वर से अनुरोध करते हैं, हमें जवाब मिलता है - JSON में कंपनियों की सूची - इसे प्रदर्शित करें

<! doctype html>
< html एनजी-ऐप >
< सिर >
< शीर्षक > बाकी अकादमी </ शीर्षक >
< script src = " ajax.googleapis.com/ajax/libs/angularjs/1.2.3/angular.min.js" > </ script >
< लिपि भाषा = "जावास्क्रिप्ट" >
फ़ंक्शन ctrl ($ गुंजाइश, $ http) {
// RESTful वेब एपीआई के लिए अनुरोध प्राप्त करें
$ http.get ( "/ बाकी / json / कंपनियाँ" )। असफल ( फ़ंक्शन (डेटा) {
// सर्वर प्रतिक्रिया को कंपनियों के वेरिएबल में रखें
$ गुंजाइश । ppp = data.children;
})। त्रुटि ( फ़ंक्शन (डेटा, स्थिति) {
// आउटपुट एरर की जानकारी यदि कोई होती है
चेतावनी ( "[" + स्थिति + "] कंपनियों को लोड करने में त्रुटि! [" + डेटा + "]" );
})
};
</ script >
</ head >
< शरीर एनजी-नियंत्रक = "ctrl" >
< div ng-repeat = "कंपनियों में कंपनी" >
{{Company.Name}}
</ div >
</ शरीर >
</ html >

हम पृष्ठ को संकलित करते हैं, पता http: // <सर्वर पते> /csp/user/rest.csp पर जाएं और कंपनियों की पूरी सूची देखें। पहले की तरह, एक उदाहरण ।

सर्वर पर क्रिएट, अपडेट, डिलीट का कार्यान्वयन

हम शेष 3 CRUD संचालन के लिए सर्वर-साइड व्यावसायिक तर्क को लागू करते हैं: एक कंपनी को जोड़ना, बदलना और हटाना।

ऐसा करने के लिए, REST.JSON वर्ग में विधियाँ जोड़ें

ClassMethod CreateCompany () % स्थिति के रूप में
{
s st = $$$ ठीक है
कोशिश करो {
// JSON को अनुरोध से लें और इसे क्लास Data.Company के ऑब्जेक्ट में बदलें
$$$ THROWONERROR ( st , ## वर्ग ( % ZEN.Auxiliary.jsonProvider )। % ConvertJSONToObject ( % request । सामग्री , "Data.Company", Obj , 1)।
$$$ थ्रोनरोर ( st , obj । % बचाओ ())
}
भूतपूर्व {
s सेंट = पूर्व । AsStatus ()
}
सेंट छोड़ दिया
}
ClassMethod DeleteCompany ( % स्ट्रिंग के रूप में लिखें ) % स्थिति के रूप में
{
सेट सेंट = $ $ $ ओके
कोशिश करो {
$$$ THROWONERROR ( st , ## वर्ग ( Data.Company )। % DeleteId ( compid )
} पूर्व कैच {
s सेंट = पूर्व । AsStatus ()
}
सेंट छोड़ दिया
}
ClassMethod UpdateCompany ( % स्ट्रिंग के रूप में लिखें ) % स्थिति के रूप में
{
सेट सेंट = $ $ $ ओके
कोशिश करो {

$$$ थ्रोनरोर ( सेंट , ## वर्ग ( % ZEN.Auxiliary.jsonProvider )। % ConvertJSONToObject ( % request । सामग्री ,, Obj , 1) ।

// वह वस्तु खोलें जिसे हम संपादित करना चाहते हैं
सेट COMP = ## वर्ग ( Data.Company )। % OpenId ( compid )
फेंक : COMP = $ $ $ NULLOREF ## वर्ग ( % अपवाद .tatusException )। CreateFromStatus ( $$$ ERROR (5001, "कंपनी मौजूद नहीं है" ))
// संपादित करें और सहेजें
कंप्यूटर अनुप्रयोग । नाम = ओब्ज । नाम
$$$ थ्रोनरोर ( सेंट , COMP । % बचाओ ())
}
भूतपूर्व {
सेट सेंट = पूर्व । AsStatus ()
}
सेंट छोड़ दिया
}

ब्रोकर के लिए उपयुक्त पथ जोड़ें

< मार्ग Url = "/ json / company" विधि = "POST" कॉल = "REST.JSON: CreateComp" >>
< मार्ग Url = "/ json / company /: compid" विधि = "DELETE" कॉल = "REST.JSON: DeleteCompany" />
< मार्ग Url = "/ json / company /: compid" विधि = "PUT" कॉल = "REST.JSON: UpdateCompany" />

यह कैच में CRUD- पूर्ण रेस्टफुल वेब एपीआई के निर्माण को पूरा करता है।

क्लाइंट क्रिएट, अपडेट, डिलीट का कार्यान्वयन

कंपनियों को बनाने, संशोधित करने, हटाने के लिए rest.csp पृष्ठ की कार्यक्षमता जोड़ें

<!doctype html> <html ng-app> <head> <title>REST Academy</title> <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.2.3/angular.min.js"></script> <script language="javascript"> function ctrl($scope,$http) { //  GET  RESTful web API $scope.getCompanies=function() { $http.get("/rest/json/companies").success(function(data) { //      companies $scope.companies=data.children; }).error(function(data, status) { //    ,    alert("["+status+"]    ! ["+data+"]"); }); }; //    $scope.create = function (company){ $http.post("/rest/json/company",company) .success(function(data){$scope.getCompanies();$scope.alertzone="  "+company.Name;}).error(function(data,status){ $scope.alertzone="["+status+"]    :( ["+data+"]"; }); } //    $scope.update = function (company){ $http.put("/rest/json/company/"+company.ID,company) .success(function(data){$scope.alertzone="  "+company.Name;}).error(function(data,status){ //  alert(....);  alertzone $scope.alertzone="["+status+"]     :( ["+data+"]"; }); } //   $scope.delete = function (company){ $http.delete("/rest/json/company/"+company.ID) .success(function(data){$scope.getCompanies();$scope.alertzone="  "+company.Name;}).error(function(data,status){ $scope.alertzone="["+status+"]    :( ["+data+"]"; }); } }; </script> </head> <body ng-controller="ctrl" ng-init="getCompanies();"> <h4 ng-model="alertzone"><font color=red>{{alertzone}}</font></h4> <form name="compCreateForm" ng-model="company" ng-submit="create(company); company='';">   <input type="text" ng-model="company.Name"/> <input type="submit" value=""/> </form> <br> <div ng-repeat="company in companies"> <form name="compForm" ng-submit="update(company); compForm.$setPristine();"> <input type="text" ng-model="company.Name"/> <input type="submit" value="" ng-show="compForm.$dirty"/> <input type="button" value="X" ng-click="delete(company);"/> </form> </div> </body> </html>

नतीजतन, फ्रंटएंड http: // <server address> /csp/user/rest.csp पर वेब API के लिए तैयार है। एक उदाहरण है ।

कुल मिलाकर

इस लेख में, हमने सीखा कि कैसे और Caché सर्वर पर एक RESTful वेब API का निर्माण और कॉन्फ़िगर करें। कैच सर्वर के आधार पर क्लाइंट साइड का निर्माण भी संभव है।

आगे क्या है?

अगर किसी को दिलचस्पी है, तो मैं आपको सुरक्षा, अधिकारों को अलग करने, और अन्य के आधार पर एक RESTful वेब API विकसित करने के लिए अन्य उपयोगिता के बारे में बता सकता हूं।

उपयोगी लिंक

इस ट्यूटोरियल में निर्मित RESTful वेब एपीआई डाउनलोड करें
RESTful वेब API उदाहरण
InterSystems Technology Glossary - रेस्टफुल वेब API भी है
JSON निर्यात - वर्ग - class2 (SQL)
% अनुरोध - वर्ग
% प्रतिक्रिया - वर्ग
एक्सएमएल निर्यात - वर्ग

काचे में एक प्रतिष्ठित वेब एपीआई का निर्माण