PHP में "एपीआई-सेंट्रिक" वेब एप्लिकेशन का निर्माण

"एपीआई-सेंट्रिक" वेब एप्लिकेशन क्या है?
यह एक वेब एप्लिकेशन है जिसे अधिकांश कार्यक्षमता एपीआई के माध्यम से कार्यान्वित की जाती है। उदाहरण के लिए: यदि आप लॉग इन करते हैं, तो आप अपना डेटा एपीआई फ़ंक्शंस के माध्यम से भेजते हैं, और एपीआई पहले से ही परिणाम की सफलता या एक त्रुटि देता है। एपीआई की एक और विशेषता यह है कि एपीआई उपयोगकर्ता की स्थिति से स्वतंत्र है।

इसकी आवश्यकता क्यों है?
वेब डेवलपर्स के रूप में, हम देखते हैं कि प्रौद्योगिकी हर दिन विकसित होती है। और हर कोई जानता है कि लोग पीसी पर न केवल ब्राउज़र का उपयोग करते हैं, बल्कि एंड्रॉइड, ऐप्पल, विंडोज़ फोन और अन्य गैजेट्स को इंटरनेट पर अपनी पसंदीदा साइटों तक पहुंच बनाने के लिए उपयोग करते हैं।

तो एपीआई कहाँ से आता है?
एपी-सेंट्रिक एप्लिकेशन बनाने के फायदों में से एक कार्यक्षमता बनाने में मदद करना है जो किसी अन्य डिवाइस पर उपयोग किया जा सकता है, यह एक ब्राउज़र, मोबाइल फोन, टैबलेट या यहां तक ​​कि एक डेस्कटॉप एप्लिकेशन हो सकता है। आपको बस एक एपीआई बनाने की जरूरत है ताकि ये सभी डिवाइस इसके साथ इंटरैक्ट कर सकें।



इस तरह से एप्लिकेशन बनाकर, हम विभिन्न वातावरणों और विभिन्न लोगों में इसका उपयोग कर सकते हैं। इस लेख में हम एक सरल TODO एप्लिकेशन और सर्वर के साथ सहभागिता करने वाला क्लाइंट पार्ट बनाएंगे। चलो शुरू करो!

चरण 1. योजना की कार्यक्षमता
टूडो आवेदन में जो हम अब करने जा रहे हैं, हम क्रूड संचालन को लागू करते हैं।

• TODO आइटम बनाएं
• TODO आइटम पढ़ें
• TODO आइटम अपडेट करें
• TODO आइटम हटाएं

प्रत्येक TODO आइटम में होगा:

• हैडर
• अंतिम तिथि
• विवरण

एक चेक मार्क दर्शाता है कि TODO आइटम पूर्ण है
आइए हमारे एप्लिकेशन का लेआउट बनाएं



चरण 2. सर्वर एपीआई बनाना

आइए 2 प्रोजेक्ट बनाएं: एपीआई सर्वर (बैक एंड) और क्लाइंट पार्ट (फ्रंट एंड)
एक simpletodo_api फ़ोल्डर बनाएँ और इसमें एक index.php फ़ाइल बनाएँ। यह हमारे एपीआई (फ्रंट कंट्रोलर) का मुख्य नियंत्रक होगा ताकि एपीआई सर्वर के सभी अनुरोध इस फाइल के माध्यम से किए जाएंगे। इसे खोलें और निम्नलिखित कोड पेस्ट करें:

<?php // Define path to data folder define('DATA_PATH', realpath(dirname(__FILE__).'/data')); //include our models include_once 'models/TodoItem.php'; //wrap the whole thing in a try-catch block to catch any wayward exceptions! try { //get all of the parameters in the POST/GET request $params = $_REQUEST; //get the controller and format it correctly so the first //letter is always capitalized $controller = ucfirst(strtolower($params['controller'])); //get the action and format it correctly so all the //letters are not capitalized, and append 'Action' $action = strtolower($params['action']).'Action'; //check if the controller exists. if not, throw an exception if( file_exists("controllers/{$controller}.php") ) { include_once "controllers/{$controller}.php"; } else { throw new Exception('Controller is invalid.'); } //create a new instance of the controller, and pass //it the parameters from the request $controller = new $controller($params); //check if the action exists in the controller. if not, throw an exception. if( method_exists($controller, $action) === false ) { throw new Exception('Action is invalid.'); } //execute the action $result['data'] = $controller->$action(); $result['success'] = true; } catch( Exception $e ) { //catch any exceptions and report the problem $result = array(); $result['success'] = false; $result['errormsg'] = $e->getMessage(); } //echo the result of the API call echo json_encode($result); exit(); 

हमने अनिवार्य रूप से एक साधारण फ्रंट कंट्रोलर बनाया है:

• एपीआई किसी भी संख्या के मापदंडों के साथ कॉल को स्वीकार करता है
• एपीआई को कॉल करने के लिए नियंत्रक और कार्रवाई को पुनः प्राप्त करता है
• नियंत्रक और कार्रवाई के अस्तित्व के लिए आवश्यक जांच करता है।
• एक एपीआई कॉल करें
• त्रुटियों को पकड़ता है
• परिणाम भेजता है

फ़ोल्डर नियंत्रक, मॉडल और डेटा भी बनाएं।
नियंत्रक फ़ोल्डर में API सर्वर द्वारा उपयोग किए जाने वाले सभी नियंत्रक होंगे। हम अपने एपीआई सर्वर को साफ और लचीला बनाने के लिए mvc आर्किटेक्चर का निर्माण करेंगे।
मॉडल फ़ोल्डर में सभी एप सर्वर के मॉडल होंगे
डेटा फ़ोल्डर सभी डेटा को स्टोर करेगा
चलो कंट्रोलर फ़ोल्डर में जाएं और todo.php बनाएं
यह अन्य TODO संबंधित कार्य सूची के लिए हमारा नियंत्रक होगा। हम अपने आवेदन के लिए एक वर्ग रिक्त और कार्यक्षमता बनाते हैं:

 <?php class Todo { private $_params; public function __construct($params) { $this->_params = $params; } public function createAction() { //create a new todo item } public function readAction() { //read all the todo items } public function updateAction() { //update a todo item } public function deleteAction() { //delete a todo item } } 

अब एक्शन एक्शन के लिए आवश्यक कार्यक्षमता जोड़ें। हम createAction विधि बनाते हैं। यदि आप एक अच्छे मूड में हैं, तो आप अन्य कार्यों के लिए कार्यक्षमता बना सकते हैं, मैंने अभी एक इंटरफ़ेस प्रदान किया है।

 public function createAction() { //create a new todo item $todo = new TodoItem(); $todo->title = $this->_params['title']; $todo->description = $this->_params['description']; $todo->due_date = $this->_params['due_date']; $todo->is_done = 'false'; //pass the user's username and password to authenticate the user $todo->save($this->_params['username'], $this->_params['userpass']); //return the todo item in array format return $todo->toArray(); } 

हम मॉडल में todoItem.php बनाते हैं ताकि हम "एक सूची आइटम बनाना" कोड को लागू कर सकें। वैसे, इस उदाहरण में - डेटाबेस के बिना (फ़ाइलों पर)। आप निश्चित रूप से, सीमित नहीं हो सकते।

 <?php class TodoItem { public $todo_id; public $title; public $description; public $due_date; public $is_done; public function save($username, $userpass) { //get the username/password hash $userhash = sha1("{$username}_{$userpass}"); if( is_dir(DATA_PATH."/{$userhash}") === false ) { mkdir(DATA_PATH."/{$userhash}"); } //if the $todo_id isn't set yet, it means we need to create a new todo item if( is_null($this->todo_id) || !is_numeric($this->todo_id) ) { //the todo id is the current time $this->todo_id = time(); } //get the array version of this todo item $todo_item_array = $this->toArray(); //save the serialized array version into a file $success = file_put_contents(DATA_PATH."/{$userhash}/{$this->todo_id}.txt", serialize($todo_item_array)); //if saving was not successful, throw an exception if( $success === false ) { throw new Exception('Failed to save todo item'); } //return the array version return $todo_item_array; } public function toArray() { //return an array version of the todo item return array( 'todo_id' => $this->todo_id, 'title' => $this->title, 'description' => $this->description, 'due_date' => $this->due_date, 'is_done' => $this->is_done ); } } 

CreateAction विधि कॉल के 2 फ़ंक्शंस todoItem मॉडल:

• सहेजें () - todoItem को एक फ़ाइल में सहेजता है, और यदि आवश्यक हो तो todoItem के लिए भी todo_id बनाता है।
• toArray () - एक सरणी के रूप में todoItem लौटाता है, जिनमें से चर चर हैं

स्थानीयहोस्ट / simpletodo_api /? नियंत्रक = todo और कार्रवाई = बनाएँ और शीर्षक = परीक्षण% 20title और विवरण = परीक्षण% 20description और देय_date = 12/08/2011 और उपयोगकर्ता नाम = nikko और userpass = = 1234 यदि सब कुछ काम करता है, तो आपको उस डेटा फ़ोल्डर में एक नया फ़ोल्डर देखना चाहिए जिसमें इस सामग्री का एक पाठ दस्तावेज़ होगा।


बधाई! हमने सफलतापूर्वक एक एपीआई सर्वर बनाया है और एक एपीआई कॉल किया है।

स्टेप 3. ऐप आईडी और ऐप सीक्रेट के साथ एपीआई सर्वर को सुरक्षित रखें।
अब हमारा एपीआई सर्वर सभी अनुरोधों को स्वीकार करता है। हमें यह सुनिश्चित करने के लिए सर्वर तक पहुंच को प्रतिबंधित करना चाहिए कि केवल हमारे स्वयं के ग्राहक ही एपीआई अनुरोध करने में सक्षम हैं। आप एक ऐसी प्रणाली भी बना सकते हैं जिसमें उपयोगकर्ता अपने स्वयं के एप्लिकेशन बना सकते हैं जिनके पास एपीआई सर्वर तक पहुंच है, फेसबुक और ट्व्टर एप्लिकेशन के समान कैसे काम करते हैं।
आइए ग्राहकों के लिए एक आईडी-की जोड़ी बनाकर शुरू करें जो हमारे सर्वर का उपयोग करेंगे। चूंकि यह एक डेमो है, हम एक यादृच्छिक 32 वर्ण स्ट्रिंग का उपयोग कर सकते हैं। APP ID के लिए, हम 'app001' कहते हैं।
Index.php खोलें और इसे बदलें:

 <?php // Define path to data folder define('DATA_PATH', realpath(dirname(__FILE__).'/data')); //Define our id-key pairs $applications = array( 'APP001' => '28e336ac6c9423d946ba02d19c6a2632', //randomly generated app key ); //include our models include_once 'models/TodoItem.php'; //wrap the whole thing in a try-catch block to catch any wayward exceptions! try { //*UPDATED* //get the encrypted request $enc_request = $_REQUEST['enc_request']; //get the provided app id $app_id = $_REQUEST['app_id']; //check first if the app id exists in the list of applications if( !isset($applications[$app_id]) ) { throw new Exception('Application does not exist!'); } //decrypt the request $params = json_decode(trim(mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $applications[$app_id], base64_decode($enc_request), MCRYPT_MODE_ECB))); //check if the request is valid by checking if it's an array and looking for the controller and action if( $params == false || isset($params->controller) == false || isset($params->action) == false ) { throw new Exception('Request is not valid'); } //cast it into an array $params = (array) $params; ... ... ... 

हमने सार्वजनिक-निजी कुंजी प्रमाणीकरण का उपयोग करके उपयोगकर्ताओं को प्रमाणित करने के लिए एक बहुत ही सरल तरीके से एक सरल कार्यान्वयन किया। यहाँ यह कैसा दिखता है:

• एक एपीआई कॉल किया जाता है, यह $ APP_ID और $ enc_request प्रदान करता है
• $ enc_request में एपीपी कुंजी का उपयोग कर एन्क्रिप्टेड एपीआई कॉल पैरामीटर शामिल हैं। एपीपी कुंजी सर्वर पर कभी नहीं भेजी जाती है, इसका उपयोग केवल अनुरोध को एन्क्रिप्ट करने के लिए किया जाता है। वैसे, एपीपी कुंजी का उपयोग करके अनुरोध को डिक्रिप्ट किया जा सकता है।
• जब कॉल सर्वर तक पहुंचता है, तो सर्वर एपीपी आईडी के लिए एप्लिकेशन की अपनी सूची की जांच करता है।
• जब यह पता चलता है, तो एपीआई सर्वर कुंजी का उपयोग करके अनुरोध को डिक्रिप्ट करने की कोशिश करता है।
• यदि डिक्रिप्शन सफल होता है, तो प्रोग्राम निष्पादन जारी रहता है

चरण 4. सामने के छोर का निर्माण
चलो एक नई निर्देशिका simpletodo_client_browser बनाते हैं।
और index.php:

 <!DOCTYPE html> <html> <head> <title>SimpleTODO</title> <link rel="stylesheet" href="css/reset.css" type="text/css" /> <link rel="stylesheet" href="css/bootstrap.min.css" type="text/css" /> <script src="js/jquery.min.js"></script> <script src="js/jquery-ui-1.8.16.custom.min.js"></script> <style> body { padding-top: 40px; } #main { margin-top: 80px; text-align: center; } </style> </head> <body> <div class="topbar"> <div class="fill"> <div class="container"> <a class="brand" href="index.php">SimpleTODO</a> </div> </div> </div> <div id="main" class="container"> <form class="form-stacked" method="POST" action="login.php"> <div class="row"> <div class="span5 offset5"> <label for="login_username">Username:</label> <input type="text" id="login_username" name="login_username" placeholder="username" /> <label for="login_password">Password:</label> <input type="password" id="login_password" name="login_password" placeholder="password" /> </div> </div> <div class="actions"> <button type="submit" name="login_submit" class="btn primary large">Login or Register</button> </div> </form> </div> </body> </html> 

यह इस तरह दिखना चाहिए:

वैसे, हमने 2 जेएस और 1 सीएसएस फाइलें शामिल कीं

• bootstrap.min.css ट्विटर बूटस्ट्रैप है
• jquery.min.js नवीनतम jQuery लाइब्रेरी है
• jquery-ui-1.8.16.custom.min.js नवीनतम jQuery UI लाइब्रेरी

अगला, सत्र के अंदर उपयोगकर्ता नाम और पासवर्ड बचाने के लिए login.php बनाएं:

 <?php //get the form values $username = $_POST['login_username']; $userpass = $_POST['login_password']; session_start(); $_SESSION['username'] = $username; $_SESSION['userpass'] = $userpass; header('Location: todo.php'); exit(); 

यहां हम केवल दर्ज उपयोगकर्ता नाम और पासवर्ड के आधार पर एक नया उपयोगकर्ता सत्र बनाते हैं। यह क्रिया एक सरल कुंजी संयोजन है जिसके द्वारा हम संग्रहीत TODO सूचियों तक पहुँच सकते हैं। अगला, एपीआई सर्वर के साथ बातचीत शुरू करने के लिए todo.php को पुनर्निर्देशित करें। Todo.php बनाने से पहले, पहले ApiCaller वर्ग को परिभाषित करते हैं, जो हमारे लिए आवश्यक सभी एपीआई कॉल विधियों को एन्क्रिप्ट करता है, जिसमें अनुरोध एन्क्रिप्शन भी शामिल है।
Apicaller.php बनाएं:

 <?php class ApiCaller { //some variables for the object private $_app_id; private $_app_key; private $_api_url; //construct an ApiCaller object, taking an //APP ID, APP KEY and API URL parameter public function __construct($app_id, $app_key, $api_url) { $this->_app_id = $app_id; $this->_app_key = $app_key; $this->_api_url = $api_url; } //send the request to the API server //also encrypts the request, then checks //if the results are valid public function sendRequest($request_params) { //encrypt the request parameters $enc_request = base64_encode(mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $this->_app_key, json_encode($request_params), MCRYPT_MODE_ECB)); //create the params array, which will //be the POST parameters $params = array(); $params['enc_request'] = $enc_request; $params['app_id'] = $this->_app_id; //initialize and setup the curl handler $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $this->_api_url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, count($params)); curl_setopt($ch, CURLOPT_POSTFIELDS, $params); //execute the request $result = curl_exec($ch); //json_decode the result $result = @json_decode($result); //check if we're able to json_decode the result correctly if( $result == false || isset($result['success']) == false ) { throw new Exception('Request was not correct'); } //if there was an error in the request, throw an exception if( $result['success'] == false ) { throw new Exception($result['errormsg']); } //if everything went great, return the data return $result['data']; } } 

हम अपने एपीआई सर्वर के लिए अनुरोध भेजने के लिए ApiCaller वर्ग का उपयोग करेंगे। इस प्रकार, CURL के सभी आवश्यक एन्क्रिप्शन और इनिशियलाइज़ेशन एक ही स्थान पर होंगे, और कोड पुनरावृत्ति भी नहीं होगी।
कंस्ट्रक्टर में 3 पैरामीटर होते हैं:

• $ app_id - ग्राहक के लिए एपीपी आईडी (APP001)
• $ app_key - ग्राहक के लिए एपीपी कुंजी (28e336ac6c9423d946ba02d19c6262632)
• $ api_url - एपीआई सर्वर URL, लोकलहोस्ट / simpletodo_api /

और SendRequest () फ़ंक्शन:

• एनक्रिप्ट सर्वर, उसी क्रम में mcrypt लाइब्रेरी का उपयोग करते हुए पैरामीटर का अनुरोध करता है, जिसे API सर्वर डिक्रिप्ट करता है
• एपीआई सर्वर को भेजे जाने के लिए $ _POST पैरामीटर उत्पन्न करता है
• CURL के माध्यम से एक एपीआई कॉल करता है
• कॉल के परिणाम की जाँच करता है (सफल है या नहीं)
• जब सबकुछ सफलतापूर्वक भेजा गया तो डेटा लौटाता है।

अब, todo.php बनाते हैं। अर्थात्, हम एक कोड बनाएंगे जो उपयोगकर्ता के एंटन और पासवर्ड habr_hello के लिए टूडू आइटम की सूची लौटाएगा।

 <?php session_start(); include_once 'apicaller.php'; $apicaller = new ApiCaller('APP001', '28e336ac6c9423d946ba02d19c6a2632', 'http://localhost/simpletodo_api/'); $todo_items = $apicaller->sendRequest(array( 'controller' => 'todo', 'action' => 'read', 'username' => $_SESSION['username'], 'userpass' => $_SESSION['userpass'] )); echo ''; var_dump($todo_items); 

हम मुख्य एक पर जाते हैं और एन्टन और हब्रेलो के नीचे लॉग इन करते हैं और आपको var_dump का परिणाम देखना चाहिए। बधाई! आपने एपीआई सर्वर से सफलतापूर्वक अनुरोध पूरा कर लिया है। इस कोड में, हम:

• एक सत्र बनाया
• ऐप आईडी, ऐप कुंजी todo.php पास करके ApiCaller वर्ग का एक उदाहरण बनाया।

आइए कुछ विशेषताओं को जोड़कर हमारे पृष्ठ को बदलते हैं।
वैसे, var डंप ^ _ ^ को हटाना न भूलें।

 <!DOCTYPE html> <html> <head> <title>SimpleTODO</title> <link rel="stylesheet" href="css/reset.css" type="text/css" /> <link rel="stylesheet" href="css/bootstrap.min.css" type="text/css" /> <link rel="stylesheet" href="css/flick/jquery-ui-1.8.16.custom.css" type="text/css" /> <script src="js/jquery.min.js"></script> <script src="js/jquery-ui-1.8.16.custom.min.js"></script> <style> body { padding-top: 40px; } #main { margin-top: 80px; } .textalignright { text-align: right; } .marginbottom10 { margin-bottom: 10px; } #newtodo_window { text-align: left; display: none; } </style> <script> $(document).ready(function() { $("#todolist").accordion({ collapsible: true }); $(".datepicker").datepicker(); $('#newtodo_window').dialog({ autoOpen: false, height: 'auto', width: 'auto', modal: true }); $('#newtodo').click(function() { $('#newtodo_window').dialog('open'); }); }); </script> </head> <body> <div class="topbar"> <div class="fill"> <div class="container"> <a class="brand" href="index.php">SimpleTODO</a> </div> </div> </div> <div id="main" class="container"> <div class="textalignright marginbottom10"> <span id="newtodo" class="btn info">Create a new TODO item</span> <div id="newtodo_window" title="Create a new TODO item"> <form method="POST" action="new_todo.php"> <p>Title:<br /><input type="text" class="title" name="title" placeholder="TODO title" /></p> <p>Date Due:<br /><input type="text" class="datepicker" name="due_date" placeholder="MM/DD/YYYY" /></p> <p>Description:<br /><textarea class="description" name="description"></textarea></p> <div class="actions"> <input type="submit" value="Create" name="new_submit" class="btn primary" /> </div> </form> </div> </div> <div id="todolist"> <?php foreach($todo_items as $todo): ?> <h3><a href="#"><?php echo $todo->title; ?></a></h3> <div> <form method="POST" action="update_todo.php"> <div class="textalignright"> <a href="delete_todo.php?todo_id=<?php echo $todo->todo_id; ?>">Delete</a> </div> <div> <p>Date Due:<br /><input type="text" id="datepicker_<?php echo $todo->todo_id; ?>" class="datepicker" name="due_date" value="12/09/2011" /></p> <p>Description:<br /><textarea class="span8" id="description_<?php echo $todo->todo_id; ?>" class="description" name="description"><?php echo $todo->description; ?></textarea></p> </div> <div class="textalignright"> <?php if( $todo->is_done == 'false' ): ?> <input type="hidden" value="false" name="is_done" /> <input type="submit" class="btn" value="Mark as Done?" name="markasdone_button" /> <?php else: ?> <input type="hidden" value="true" name="is_done" /> <input type="button" class="btn success" value="Done!" name="done_button" /> <?php endif; ?> <input type="hidden" value="<?php echo $todo->todo_id; ?>" name="todo_id" /> <input type="hidden" value="<?php echo $todo->title; ?>" name="title" /> <input type="submit" class="btn primary" value="Save Changes" name="update_button" /> </div> </form> </div> <?php endforeach; ?> </div> </div> </body> </html> 

यह इस तरह दिखना चाहिए:

यह अच्छा लग रहा है, है ना? अब समान कार्यक्षमता जोड़ें, new_todo.php
जिसमें एक TODO / कॉल शामिल है, जिससे एक नया TODO आइटम तत्व बनता है। अन्य पृष्ठ बनाना: (update_todo.php और delete_todo.php) सरल होना चाहिए।
New_todo.php खोलें:

 <?php session_start(); include_once 'apicaller.php'; $apicaller = new ApiCaller('APP001', '28e336ac6c9423d946ba02d19c6a2632', 'http://localhost/simpletodo_api/'); $new_item = $apicaller->sendRequest(array( 'controller' => 'todo', 'action' => 'create', 'title' => $_POST['title'], 'due_date' => $_POST['due_date'], 'description' => $_POST['description'], 'username' => $_SESSION['username'], 'userpass' => $_SESSION['userpass'] )); header('Location: todo.php'); exit(); ?> 

जैसा कि आप देख सकते हैं, new_todo.php ApiCaller का उपयोग सर्वर के एपीआई को टूडू / अनुरोध भेजने के लिए करता है।

• सत्र शुरू होता है
• ApiCaller वर्ग का आरंभीकरण
• SendRequest () का उपयोग करके अनुरोध भेजना
• todo.php पर पुनर्निर्देशित करें

बधाई! हमने API-केंद्रित वेब एप्लिकेशन को सफलतापूर्वक बनाया है।

निष्कर्ष:
एपीआई के साथ किए गए एप्लिकेशन विकसित करने के कई फायदे हैं। यदि आप SimpleTODO का एक Android संस्करण बनाना चाहते हैं, तो आपके लिए आवश्यक सभी कार्यक्षमता पहले से ही API सर्वर में है, इसलिए आपको बस एक Android क्लाइंट बनाना होगा! कुछ वर्गों का पुनर्गठन या अनुकूलन करना चाहते हैं? कोई समस्या नहीं - बस सुनिश्चित करें कि आउटपुट समान है। अधिक कार्यक्षमता जोड़ने की आवश्यकता है? आप क्लाइंट कोड को बदले बिना ऐसा कर सकते हैं!

प्रेरणा nettuts लेख था ।
यदि मैंने कोई गलती की है, तो लिखें और टिप्पणी करें कि बेहतर क्या किया जा सकता है