👩🏽‍🏭 🤙🏽 🙋🏼 कैसे मैं Yiinitializr उन्नत में एपीआई काम किया है 🚣 👨🏿‍🚒 👆🏻

Yiinitializr जैसे दिलचस्प उपकरण के बारे में अपनी पिछली पोस्ट जारी रखने में, मैंने उन्नत टेम्पलेट द्वारा प्रदान की गई एपीआई क्षमताओं के बारे में एक सवाल का जवाब देने का फैसला किया। टिप्पणी या पिछले लेख के अतिरिक्त पैराग्राफ के हिस्से के रूप में, सामग्री को समायोजित नहीं किया जा सकता है, इसलिए मैं उन सभी को आमंत्रित करता हूं जो इस विषय में दिलचस्पी रखते हैं। इसमें, हम सही एपीआई वास्तुकला को डिजाइन करने के सिद्धांतों पर नहीं छूएंगे , लेकिन यह पता लगाएंगे कि 2amigos से लोगों के काम का लाभ कैसे उठाया जाए , जिन्होंने हमें जल्दी से जल्दी (लेख पढ़ने के बाद - बिल्कुल जल्दी) यूआई पर हमारी परियोजनाओं के लिए एपीआई तैनात किया।

Yiinitializr में एपीआई के साथ काम करने का तरीका

एपीआई - अनुप्रयोग प्रोग्रामिंग इंटरफ़ेस बाहरी सॉफ़्टवेयर उत्पादों में उपयोग के लिए उपयोग किया जाता है। यदि हम चाहते हैं कि अन्य डेवलपर्स अपनी परियोजनाओं में हमारे आवेदन की क्षमताओं का लाभ उठाएं, तो हम एक अच्छी तरह से डिज़ाइन किए गए एपीआई के बिना नहीं कर सकते। दुर्भाग्य से, पहले संस्करण के Yii इस मामले में मदद करने में सक्षम नहीं होंगे। Yiinitializr शायद आपको सूट करेगा, जो कुछ मुद्दों को हल करेगा, लेकिन, जैसा कि हम जानते हैं, प्रलेखन की कमी एक गंभीर बाधा है।

कल्पना करें कि हमारे अद्भुत एप्लिकेशन पर काम पूरा हो गया है, एपीआई का काम स्थापित हो गया है, और पहले डेवलपर पहले ही दिखाई दे चुके हैं जो हमारे सिस्टम की क्षमताओं का लाभ उठाना चाहते हैं। इसका उपयोग किस सिद्धांत पर आधारित होगा?

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

उन्नत टेम्पलेट अंतर

अगर पहले हम इंटरमीडिएट टेम्पलेट के बारे में बात कर रहे थे, तो अब एक नज़र डालते हैं कि एडवांस्ड टेम्पलेट में क्या जोड़ा गया है। जैसा कि आप पहले से ही समझ चुके हैं, यह हमारे द्वारा दी जाने वाली सभी अतिरिक्त सुविधाएँ एपीआई से संबंधित हैं। डाउनलोड करें, अनपैक करें और हमारे पास जो अभी है ./api देखने के लिए ./api निर्देशिका पर जाएं। और हमारे पास है:

./api/extensions/filters/EApiAccessControlFilter.php - एपीआई एक्सेस नियमों की जाँच के लिए एक फ़िल्टर वर्ग।
./api/extensions/components/EApiAccessRule.php - वह वर्ग जो API एक्सेस नियम का प्रतिनिधित्व करता है।
./api/extensions/components/EApiActiveRecord.php - एपीआई के साथ एआर-मॉडल के साथ काम करने के सहायक तरीकों के लिए एक वर्ग।
./api/extensions/components/EApiController.php - एपीआई अनुरोधों को संसाधित करने के लिए नियंत्रक वर्ग।
./api/extensions/components/EApiError.php - एपीआई त्रुटि वर्ग जो पढ़ने के लॉग की सुविधा के लिए मौजूद है।
./api/extensions/components/EApiErrorHandler.php - एपीआई त्रुटियों को संभालने के लिए वर्ग। यदि हम डेटाबेस में त्रुटियों को लॉग करने का निर्णय लेते हैं, तो हम इस विशेष वर्ग का उपयोग करेंगे।
./api/models/ApiUser.php एक मॉडल का एक उदाहरण है जिसे हम अपने एपीआई के बाहरी उपयोगकर्ताओं को प्रबंधित करेंगे।
./common/lib/YiiRestTools/ - ./common/lib/YiiRestTools/ एपीआई के कामकाज के लिए सहायक कक्षाएं।

यह सामान्य जानकारी सीधे एपीआई के माध्यम से हमारे सिस्टम के साथ एक तृतीय-पक्ष एप्लिकेशन के इंटरैक्शन के कार्यान्वयन के लिए जाने के लिए पर्याप्त होगी।

कॉन्फ़िगरेशन और बग ठीक करता है

Yiinitializr डेवलपर्स ने स्पष्ट रूप से पेरेटो सिद्धांत का पालन किया, और 80% काम करने के बाद, उन्होंने प्रलेखन और कीड़े को ठीक करने में 80% समय खर्च नहीं करने का फैसला किया, इसे परिष्कृत डेवलपर्स (यानी हम) के कंधों पर डाल दिया।

चूंकि हमने Yiinitializr स्थापित करने का निर्णय लिया है, निश्चित रूप से हम कॉन्फ़िगरेशन फ़ाइल में रुचि रखते हैं। आइए इसे खोलें और API रूटिंग ( ./api/config/api.php ) के नियमों को देखें:

 'rules' => array( // REST patterns array('<controller>/index', 'pattern' => 'api/<controller:\w+>', 'verb' => 'POST'), array('<controller>/view', 'pattern' => 'api/<controller:\w+>/view', 'verb' => 'POST'), array('<controller>/update', 'pattern' => 'api/<controller:\w+>/update', 'verb' => 'PUT'), array('<controller>/delete', 'pattern' => 'api/<controller:\w+>/delete', 'verb' => 'DELETE'), array('<controller>/create', 'pattern' => 'api/<controller:\w+>/create', 'verb' => 'POST'), ),

हमें कुछ समझ में नहीं आता है। टिप्पणी हमें बताती है कि यह एक REST टेम्प्लेट है, लेकिन वास्तव में हमें ऐसा नहीं मिलता है। REST मानता है कि सभी अनुरोध एक ही URL पर जाते हैं, और क्रियाएँ HTTP तरीकों और अनुरोध मापदंडों के आधार पर चुनी जाती हैं, अर्थात् यह इस तरह होना चाहिए:

पता	HTTP विधि	कड़ी कार्रवाई की
api.yiinitializr.dev/test/	प्राप्त	TestController \ actionIndex ()
api.yiinitializr.dev/test/1/	प्राप्त	TestController \ ActionView (1)
api.yiinitializr.dev/test/	पोस्ट	TestController \ ActionCreate ()
api.yiinitializr.dev/test/1/	PUT	TestController \ ActionUpdate (1)
api.yiinitializr.dev/test/1/	हटाएँ	TestController \ actionDelete (1)

हम नियमों को वांछित रूप में लाते हैं:

 'rules' => array( // REST patterns array('<controller>/index', 'pattern' => '<controller:\w+>', 'verb' => 'GET'), array('<controller>/view', 'pattern' => '<controller:\w+>/<id:\d+>', 'verb' => 'GET'), array('<controller>/update', 'pattern' => '<controller:\w+>/<id:\d+>', 'verb' => 'PUT'), array('<controller>/delete', 'pattern' => '<controller:\w+>/<id:\d+>', 'verb' => 'DELETE'), array('<controller>/create', 'pattern' => '<controller:\w+>', 'verb' => 'POST'), ),

हमें कॉन्फ़िगरेशन फ़ाइल में वर्तमान चरण के लिए वास्तव में महत्वपूर्ण कुछ भी नहीं मिलेगा, इसलिए हम अन्य समस्याओं के लिए आगे बढ़ते हैं। पहले एक का समाधान बिल्कुल सरल है - पोर्टेबल

 use YiiRestTools\Helpers\RequestData; use Yiinitializr\Helpers\ArrayX;

EApiAccessControlFilter.php से EApiAccessRule.php , EApiAccessRule.php ये कक्षाएं दूसरी फ़ाइल में उपयोग की जाती हैं।

निम्नलिखित समस्या पहले से ही अधिक दिलचस्प है। शायद मुझे कुछ समझ नहीं आया, इसलिए मैंने एक साथ तर्क करने का प्रस्ताव रखा। नीचे दिए गए कोड ( ./api/extensions/components/EApiAccessRule.php ) पर करीब से नज़र डालें:

 public function isRequestAllowed($user, $controller, $action, $ip, $verb) { if ($this->isActionMatched($action) && $this->isUserMatched(Yii::app()->user) && $this->isRoleMatched(Yii::app()->user) && $this->isSignatureMatched($user) && $this->isIpMatched($ip) && $this->isVerbMatched($verb) && $this->isControllerMatched($controller) ) { return $this->allow ? 1 : -1; } else { return 0; } }

isRequestAllowed अनुरोध नियमों से मेल खाता है, isRequestAllowed विधि जाँच करती है। यदि ब्लॉक में चेक की श्रृंखला सही है, तो यह नियम लागू होता है, 1 या -1 लौटाता है, जो इस नियम पर निर्भर करता है - अनुमति देता है या इनकार करता है। अन्यथा, यह नियम किसी विशेष अनुरोध पर लागू नहीं होता है और विधि 0. वापस आ जाती है। इसे स्पष्ट करने के लिए, मैं आपको याद दिलाता हूं कि निम्नलिखित नियम क्या हैं:

 public function filters() { return array( array( 'EApiAccessControlFilter -error', 'rules' => array( array('allow', 'users' => array('@')), ) ) ); }

एक बात भ्रमित करती है, अर्थात् हस्ताक्षर सत्यापन $this->isSignatureMatched($user) इस श्रृंखला में $this->isSignatureMatched($user) । गलत हस्ताक्षर प्राप्त करने पर, सिस्टम यह निर्णय लेता है कि यह नियम लागू नहीं है और तदनुसार उपयोगकर्ता (या हैकर) को अंदर पारित करता है। सबसे अधिक संभावना है, हस्ताक्षर का सत्यापन सही अनुरोध के बाद किया जाना चाहिए, और परिणाम से, हमें सिस्टम में आने दें या न दें। इसलिए, आपको इस विधि को थोड़ा संशोधित करने की आवश्यकता है:

 public function isRequestAllowed($user, $controller, $action, $ip, $verb) { if ($this->isActionMatched($action) && $this->isUserMatched(Yii::app()->user) && $this->isRoleMatched(Yii::app()->user) && $this->isIpMatched($ip) && $this->isVerbMatched($verb) && $this->isControllerMatched($controller) ) { return ($this->allow && $this->isSignatureMatched($user)) ? 1 : -1; } else { return 0; } }

खामियां खत्म होती दिख रही हैं। प्रलेखन की कमी खेलने में आती है। एक कदम-दर-चरण डिबगर की मदद से, मैंने एपीआई कक्षाओं के बीच बातचीत के तंत्र का अध्ययन किया और मैं आपके साथ टिप्पणियों को साझा करने में जल्दबाजी करता हूं।

आरंभ करने के लिए, मूल मार्गदर्शिका में बताई गई बुनियादी रूपरेखाएँ बनाएं। तो चलो उस विन्यास में HTTP हेडर का नाम परिभाषित करते हैं जिसमें हम सार्वजनिक कुंजी ( ./api/config/api.php ) ./api/config/api.php :

 'params' => array( 'api.key.name' => 'APIKEY', )

सही समय क्षेत्र सेट करना न भूलें (यह हमारे सिस्टम और क्लाइंट एप्लिकेशन के लिए समान होना चाहिए) ( common/config/main.php ):

 'params' => array( ... 'php.timezone' => 'Europe/Moscow', ),

हम इंस्टॉलर के माध्यम से स्थापना शुरू करते हैं, यह पहले से ही संभव है ।
अब, एपीआई का परीक्षण करने के लिए, हमें एक बाहरी उपयोगकर्ता को पंजीकृत करने की आवश्यकता है। एक नया माइग्रेशन बनाएँ:

 > yiic migrate create create_api_user_table

और हम निम्नलिखित फॉर्म में up() और down() तरीके लाते हैं:

 public function up() { $this->createTable('{{api_user}}', array( 'id' => 'pk', 'username' => 'varchar(32) NOT NULL', 'api_key' => 'varchar(32) NOT NULL', 'api_secret' => 'varchar(32) NOT NULL', )); $this->insert('{{api_user}}', array( 'username' => 'test_user', 'api_key' => 'e4afe26b5b57083f74b2d01c7066379c', // md5('public_key') 'api_secret' => '156a17333e77a3c504018cae5ada8c3b', // md5('private_key') )); } public function down() { $this->dropTable('{{api_user}}'); }

हम ApiUser मॉडल में हमारे API के उपयोगकर्ताओं वाले तालिका का नाम भी संपादित करते हैं।

 class ApiUser extends EApiActiveRecord { ... public function tableName() { return '{{api_user}}'; } ... }

हम अपना माइग्रेशन लागू करते हैं। परिणाम हमारे एपीआई के एकमात्र काल्पनिक उपयोगकर्ता के साथ डेटाबेस में एक तालिका होगी। चलिए आगे बढ़ते हैं।

एक साधारण क्लाइंट एप्लिकेशन लिखना

अंतिम कदम Yiinitializr एपीआई के साथ काम करने के लिए एक सरल ग्राहक आवेदन लिखना है। इसे काम करने के लिए, आपको विभिन्न HTTP विधियों का उपयोग करके अनुरोध भेजने में सक्षम होना चाहिए, cURL लाइब्रेरी हमें इसमें मदद करेगी। आगे की हलचल के बिना, सभी कोड स्पॉइलर के लिए रखे गए हैं। खोलो, देखो, कॉपी करो।

SimpleClient ग्राहक वर्ग

हस्ताक्षर बनाने के लिए prepareData($secretKey) विधि RequestData पुस्तकालय के prepareData($secretKey) वर्ग की prepareData($secretKey) विधि पर आधारित है।

 /** * Class SimpleClient * * Simple REST-client for Yiinitializr Advanced API. */ class SimpleClient { private $baseUrl; private $apiPublic; private $apiSecret; private $expiration; public function __construct($url, $publicKey, $secretKey, $expiration = '+1 hour') { $this->baseUrl = $url; $this->apiPublic = $publicKey; $this->apiSecret = $secretKey; $this->expiration = $expiration; } public function makeRequest($verb, $controller, $params = array()) { $ch = curl_init(); $signature = $this->generateSignature(); $url = $this->makeUrl($controller); if (!empty($params) && isset($params['id'])) { $url .= $params['id']; } curl_setopt_array($ch, array( CURLOPT_URL => $url, CURLOPT_CUSTOMREQUEST => $verb, CURLOPT_HTTPHEADER => array('APIKEY: ' . $this->apiPublic), CURLOPT_POSTFIELDS => json_encode(array( 'signature' => $signature, 'expiration' => $this->relativeTimeToAbsolute($this->expiration), )), )); $result = curl_exec($ch); curl_close($ch); return $result; } private function generateSignature() { $ttdInt = strtotime($this->expiration); $raw = json_encode(array('expiration' => gmdate('Ymd\TH:i:s\Z', $ttdInt))); $jsonPolicy64 = base64_encode($raw); $signature = base64_encode(hash_hmac( 'sha1', $jsonPolicy64, $this->apiSecret, true )); return $signature; } private function makeUrl($controller) { return 'http://' . rtrim($this->baseUrl, '/') . '/' . $controller . '/'; } private function relativeTimeToAbsolute ($relativeTime) { return date('M d Y, H:i:s', strtotime($relativeTime)); } }

SimpleClient वर्ग के साथ काम करना

 $api = new SimpleClient('api.yiinitializr.dev', 'e4afe26b5b57083f74b2d01c7066379c', '156a17333e77a3c504018cae5ada8c3b'); $api->makeRequest('GET', 'test'); $api->makeRequest('GET', 'test', array('id' => 1)); $api->makeRequest('POST', 'test'); $api->makeRequest('PUT', 'test', array('id' => 1)); $api->makeRequest('DELETE', 'test', array('id' => 1));

परीक्षण नियंत्रक का संशोधित संस्करण

 class TestController extends EApiController { public function actionIndex() { // just drop API request :) $this->renderJson(array('response' => 'index')); } public function actionView($id) { $this->renderJson(array('response' => 'view#' . $id)); } public function actionCreate() { $this->renderJson(array('response' => 'created')); } public function actionUpdate($id) { $this->renderJson(array('response' => 'updated#' . $id)); } public function actionDelete($id) { $this->renderJson(array('response' => 'deleted#' . $id)); } }

अपाचे को कॉन्फ़िगर करें

PUT और DELETE अनुरोधों को रोकने के लिए Apache के लिए, निम्नलिखित पंक्तियों को ./api/www/.htaccess फ़ाइल में जोड़ा जाना चाहिए:

 <Limit GET POST PUT DELETE> order deny,allow allow from all </Limit>

निर्णय यहाँ किया जाता है ।

संक्षेप में कहना

इतने सरल तरीके से, हमने अपनी कार स्टार्ट की। यह समझने के लिए कि क्या है, मुझे एक दिन (और दो भी नहीं) से अधिक खर्च करने की आवश्यकता है। किसी भी मामले में, इस तरह का एक समाधान एक शुरुआती स्थिति के रूप में काफी उपयुक्त होगा, जिसके आधार पर इस मामले में गहन ज्ञान के बिना उच्च-गुणवत्ता वाला एपीआई बनाना बहुत आसान है। अतिरिक्त लिंक में से, मैं आपको Yiinitializr को ग्रेट गाइड देखने के लिए सलाह दे सकता हूं (क्या आपने अभी तक ऐसा नहीं किया है?) और लेख Yii (अंग्रेजी में) के लिए REST API कैसे बनाएं ।

टिप्पणियों में, मैं वाईवाई पर एपीआई के कार्यान्वयन पर आपके विचारों को साझा करने का प्रस्ताव करता हूं, इस पद्धति की आलोचना करता हूं और सुधार सुझाता हूं। आपका ध्यान देने के लिए धन्यवाद।

कैसे मैं Yiinitializr उन्नत में एपीआई काम किया है

Yiinitializr में एपीआई के साथ काम करने का तरीका

उन्नत टेम्पलेट अंतर

कॉन्फ़िगरेशन और बग ठीक करता है

एक साधारण क्लाइंट एप्लिकेशन लिखना

संक्षेप में कहना

More articles: