आसानी से किसी प्रोजेक्ट में एक RESTful API एम्बेड करें

यह कोई रहस्य नहीं है कि एपीआई होना किसी भी परियोजना के लिए अच्छा है। लेकिन अक्सर, सिस्टम आर्किटेक्चर में एक त्रुटि के साथ या इसे एक तैयार परियोजना में जोड़ने के लिए, समर्थन और परीक्षण के ओवरहेड में बहुत समय लगता है।

मैं समुदाय को एक कठोर वास्तुकला के हमारे कार्यान्वयन से परिचित कराना चाहता हूं, कोड की नकल के बिना और मौजूदा व्यावसायिक तर्क में कम से कम बदलाव के साथ। या किसी प्रोजेक्ट में पाँच मिनट में एपीआई कैसे जोड़ें?

इस दृष्टिकोण को लागू करने के लिए, हमने Yii फ्रेमवर्क के लिए एक एक्सटेंशन लिखा था, लेकिन इस दृष्टिकोण का उपयोग किसी भी MVC आर्किटेक्चर में किया जा सकता है।

आइए कल्पना करें कि हमारे पास एक विधि के साथ RestUserController नियंत्रक है:

• actionIndex - उपयोगकर्ता सूची
• actionView - व्यू यूजर
• actionCreate - उपयोगकर्ता बनाएँ
• actionUpdate - उपयोगकर्ता अद्यतन
• actionDelete - उपयोगकर्ता को हटा दें

हमारे पास एक RestUser मॉडल भी है, जो एक ActvieRecord rest_users टेबल है।

actionCreate विधि पर विचार करें, जिसका कार्य नया RestUser उपयोगकर्ता बनाना है,

 class RestUserController extends Controller { ... public function actionCreate() { $model = new RestUser(); if (isset($_POST) && ($data = $_POST)) { //    POST  $model->attributes = $data; //      if ($model->save()) { //  ,   -   $this->redirect(array('view', 'id' => $model->id)); } } $this->render('create', array('model' => $model)); //  html-  } ... } 

यहां सब कुछ स्पष्ट है - यदि हम केवल अनुरोध /restUser/create - एक नए उपयोगकर्ता को जोड़ने के लिए HTML फॉर्म प्रदर्शित किया जाता है, अगर हम इस पते पर एक पोस्ट अनुरोध भेजते हैं, तो यह तर्क को मान्य और जोड़ देगा, फिर या तो उपयोगकर्ता को देखने के लिए हमें पुनः निर्देशित करें या एचटीएमएल फॉर्म c देखें त्रुटियों।

अब, मान लें कि हम एक ऐसा मोबाइल एप्लिकेशन बनाना चाहते हैं जो इसके इंटरफ़ेस से नए उपयोगकर्ता बना सकेगा। सर्वर API बनाने का सही तरीका है।
क्योंकि चूंकि हम एक रैस्टफुल स्टाइल के बारे में बात कर रहे हैं, सर्वर और मोबाइल एप्लिकेशन की परस्पर क्रिया, कर्ल के माध्यम से उदाहरण के अनुरोध का उपयोग करते हुए, इस बारे में कुछ देखेंगे:

जांच

 curl http://test.local/api/users \ -u demo:demo \ -d email="user@test.local" \ -d password="passwd" 

जवाब है

 < HTTP/1.1 201 Created < Content-Type: application/json < WWW-Authenticate: Basic realm="App" < Location: http://test.local/api/users/TEST_ID { "object":"rest_user", "id":"TEST_ID", "email":"user@test.local", "name":"Test REST User" } 

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

हमारे दृष्टिकोण का पूरा विचार एपीआई अनुरोधों को सही ढंग से जवाब देने की क्षमता में क्रियाओं को जोड़ना है, केवल redirect और render तरीकों को बदलने के साथ-साथ मॉडल रेंडरिंग नियमों को जोड़ना है।
बेशक, एपीआई क्लाइंट की सही प्रतिक्रिया के लिए, एप्लिकेशन त्रुटियों और निष्पादित होने के अवरोधन, साथ ही मॉडल बनाते समय त्रुटियों को लागू करना भी आवश्यक है, लेकिन इसके लिए नियंत्रक के कार्यों के व्यापार तर्क को बदलने की आवश्यकता नहीं होगी।

हमारे विस्तार में, हमने onException और onError को इंटरसेप्ट onException और साथ ही CController का उपयोग करके बेस CActiveRecord मॉडल और CController लिए अतिरिक्त कार्यक्षमता जोड़कर प्रस्तावित दृष्टिकोण को लागू किया।
नतीजतन, कोड जो एपीआई के माध्यम से अनुरोध करते समय वांछित प्रतिक्रिया देता है, और एक नियमित रूप से अनुरोध के साथ HTML फॉर्म, इस तरह दिखाई देगा:

 class RestUserController extends Controller { ... public function actionCreate() { $model = new RestUser(); if ($this->isPost() && ($data = $_POST)) { //   isPost   isPut  isDelete $model->attributes = $data; if ($model->save()) { $this->redirect(array('view', 'id' => $model), true, 201); //   } } $this->render('create', array('model' => $model), false, array('model')); //    model } ... } 

नए कोड और पिछले एक के बीच एक महत्वपूर्ण अंतर यह है कि redirect विधि में स्थानांतरण $model->id के id पैरामीटर के रूप में नहीं $model->id , लेकिन $model ऑब्जेक्ट का, ताकि निर्मित ऑब्जेक्ट क्लाइंट को वापस कर दिया जाए। साथ ही, तीसरे पैरामीटर ने प्रतिक्रिया कोड 201 जोड़ा - यह मानक के अनुपालन के लिए आवश्यक है, क्योंकि प्रतिक्रिया के साथ, बनाया गया हेडर जिसमें ऑब्जेक्ट का पता होता है, प्रसारित होता है। प्रतिक्रिया में 3xx HTTP कोड की अनुमति नहीं है।
एक और अंतर render विधि में जोड़ा गया चौथा पैरामीटर है, जिसमें क्लाइंट के जवाब में प्रेषित किए गए $data सरणी से फ़ील्ड की गणना है। यदि पैरामीटर null तो संपूर्ण $data सरणी वापस आ जाती है।

अब, यदि अनुरोध गलत है, तो सामान्य रूप से HTML फॉर्म में प्रदर्शित होने वाला डेटा निम्नलिखित प्रारूप में लौटाया जाएगा:

जांच

 curl http://test.local/api/users \ -u demo:demo \ -d email="user@test.local" 

जवाब है

 < HTTP/1.1 400 Bad Request < Content-Type: application/json < WWW-Authenticate: Basic realm="App" { "error":{ "params":[ { "code":"required", "message":"Password cannot be blank.", "name":"password" } ], "type":"invalid_param_error", "message":"Invalid data parameters" } } 

ठीक है, अब हमें किसी तरह संवेदनशील मॉडल डेटा की रक्षा करने की आवश्यकता है - हमारे RestUser यह password फ़ील्ड है। ऐसा करने के लिए, नियम में दिए गए फ़ील्ड की सूची निर्धारित करें।
मॉडल के लिए प्रदर्शन नियम rules विधि में होगा

 class RestUser extends CModel { public function rules() { return array( ... array('id, email, name', 'safe', 'on' => 'render'), ); } } 

इस नियम को तब getRenderAttributes पद्धति में ध्यान में रखा जाएगा, जो मॉडल में जोड़ा जाता है, जो प्रदर्शन के लिए उपलब्ध सभी विशेषताओं की एक सरणी लौटाएगा, यदि वे नियम में निर्दिष्ट हैं, तो ऑब्जेक्ट के संबंधों से गुजरना।

अंत में, मैं प्रमाणीकरण और प्रदर्शन क्षमताओं के बारे में थोड़ी बात करना चाहता हूं।
विस्तार कोर घटक (सेवा) \rest\Service आसपास बनाया गया है, जो घटनाओं के मुख्य प्रसंस्करण और डेटा के सही प्रदर्शन में लगा हुआ है। इस सेवा में एडेप्टर auth और renderer दो समूह हैं।
ऑथेंटिकेशन में ऑथेंटिकेशन एडाप्टर्स हैं - डिफॉल्ट HTTP बेसिक ऑर्टिफिकेशन एडेप्टर उपलब्ध है।
renderer में डेटा प्रदर्शित करने वाले एडेप्टर होते हैं - डिफ़ॉल्ट रूप से, दो JSON और XML एडेप्टर उपलब्ध हैं।

विस्तार

संक्षेप में सेटिंग्स

उदाहरण main.php कॉन्फ़िगरेशन फ़ाइल

 YiiBase::setPathOfAlias('rest', realpath(__DIR__ . '/../extensions/yii-rest-api/library/rest')); return array( 'basePath' => dirname(__FILE__) . DIRECTORY_SEPARATOR . '..', 'name' => 'My Web Application', 'preload' => array('restService'), 'import' => array( 'application.models.*', 'application.components.*', ), 'components' => array( 'restService' => array( 'class' => '\rest\Service', 'enable' =>strpos($_SERVER['REQUEST_URI'], '/api/') !== false, //   ), 'urlManager' => array( 'urlFormat' => 'path', 'showScriptName' => false, 'baseUrl' => '', 'rules' => array( array('restUser/index', 'pattern' => 'api/v1/users', 'verb' => 'GET', 'parsingOnly' => true), array('restUser/create', 'pattern' => 'api/v1/users', 'verb' => 'POST', 'parsingOnly' => true), array('restUser/view', 'pattern' => 'api/v1/users/<id>', 'verb' => 'GET', 'parsingOnly' => true), array('restUser/update', 'pattern' => 'api/v1/users/<id>', 'verb' => 'PUT', 'parsingOnly' => true), array('restUser/delete', 'pattern' => 'api/v1/users/<id>', 'verb' => 'DELETE', 'parsingOnly' => true), array('restUser/index2', 'pattern' => 'api/v2/users', 'verb' => 'GET', 'parsingOnly' => true), //  ,      API ) ), ), ); 

नियंत्रक और पुनर्परिभाषित विधियों में व्यवहार जोड़ें

 /** * @method bool isPost() * @method bool isPut() * @method bool isDelete() * @method string renderRest(string $view, array $data = null, bool $return = false, array $fields = array()) * @method void redirectRest(string $url, bool $terminate = true, int $statusCode = 302) * @method bool isRestService() * @method \rest\Service getRestService() */ class RestUserController extends Controller { public function behaviors() { return array( 'restAPI' => array('class' => '\rest\controller\Behavior') ); } //   $fields  ,      public function render($view, $data = null, $return = false, array $fields = array('count', 'model', 'data')) { if (($behavior = $this->asa('restAPI')) && $behavior->getEnabled()) { if (isset($data['model']) && $this->isRestService() && count(array_intersect(array_keys($data), $fields)) == 1) { $data = $data['model']; //    API,      ,     -    $fields = null; } return $this->renderRest($view, $data, $return, $fields); } else { return parent::render($view, $data, $return); } } public function redirect($url, $terminate = true, $statusCode = 302) { if (($behavior = $this->asa('restAPI')) && $behavior->getEnabled()) { $this->redirectRest($url, $terminate, $statusCode); } else { parent::redirect($url, $terminate, $statusCode); } } } 

इन सभी विधियों को मूल नियंत्रक में जोड़ा जा सकता है और प्रत्येक नियंत्रक में व्यक्तिगत रूप से लागू नहीं किया जाना चाहिए।

मॉडल में व्यवहार जोड़ें ताकि रेंडरिंग नियम काम करें

 /** * @method array getRenderAttributes(bool $recursive = true) * @method string getObjectId() */ class RestUser extends CActiveRecord { /** * @return array */ public function behaviors() { return array( 'renderModel' => array('class' => '\rest\model\Behavior') ); } } 

संदर्भ

गिटहब भंडार - github.com/paysio/yii-rest-api
स्थापना और सेटअप विवरण - github.com/paysio/yii-rest-api#installation
उपरोक्त सभी कोड github.com/paysio/yii-rest-api/tree/master/demo है