🤴🏾 💯 🉑 हम अपाचे, PHP और MySQL का उपयोग करके साइट के लिए अपना एपीआई लिखते हैं 😉 🏖️ 👩‍⚕️

यह सब कैसे शुरू हुआ

परियोजना को विकसित करते समय, मुझे अपनी साइट के साथ आईओएस और एंड्रॉइड प्लेटफार्मों पर एप्लिकेशन के क्लाइंट-सर्वर इंटरैक्शन को व्यवस्थित करने की आवश्यकता का सामना करना पड़ा, जिस पर सभी जानकारी संग्रहीत की गई थी - वास्तव में mysql डेटाबेस, चित्र, फाइलें और अन्य सामग्री।
जिन कार्यों को हल करने की आवश्यकता है वे काफी सरल हैं:
उपयोगकर्ता पंजीकरण / प्राधिकरण;
कुछ डेटा भेजना / प्राप्त करना (उदाहरण के लिए, सामानों की सूची)।

और फिर मैं अपने एपीआई को सर्वर साइड के साथ बातचीत करने के लिए लिखना चाहता था - व्यावहारिक हित के लिए अधिकांश भाग के लिए।

इनपुट डेटा

मेरे निपटान में मेरे पास था:
सर्वर - अपाचे, PHP 5.0, MySQL 5.0
क्लाइंट - एंड्रॉइड, आईओएस डिवाइस, कोई भी ब्राउज़र

मैंने फैसला किया कि मैं सर्वर अनुरोधों और उससे प्राप्त प्रतिक्रियाओं के लिए JSON डेटा प्रारूप का उपयोग करूंगा - PHP और Android में इसकी सादगी और मूल समर्थन के लिए। IOS ने मुझे यहाँ परेशान किया - इसमें देशी JSON समर्थन नहीं है (मुझे यहाँ तृतीय-पक्ष विकास का उपयोग करना पड़ा)।

यह भी निर्णय लिया गया कि अनुरोध GET के माध्यम से और POST अनुरोधों के माध्यम से (PHP में $ _REQUEST यहाँ मदद की गई) दोनों को भेजा जा सकता है। इस समाधान ने किसी भी उपलब्ध ब्राउज़र में GET अनुरोधों के माध्यम से एपीआई परीक्षण की अनुमति दी।

निम्नानुसार प्रश्नों की उपस्थिति बनाने का निर्णय लिया गया:
http: // [सर्वर का पता] / [एपीआई फ़ोल्डर का पथ] /? [api_name]। [विधि_नाम] = [[JSON के फॉर्म {"हैलो": "हैलो वर्ल्ड"}]

Api फ़ोल्डर का पथ वह निर्देशिका है जिसके लिए आपको अनुरोध करने की आवश्यकता है, जिसकी जड़ index.php फ़ाइल है - यह फ़ंक्शन को कॉल करने और त्रुटियों से निपटने के लिए ज़िम्मेदार है
नाम एपीआई है - सुविधा के लिए, मैंने समूह के एपीआई को अलग करने का फैसला किया - उपयोगकर्ता, डेटाबेस, सामग्री, आदि। इस मामले में, प्रत्येक एपि को इसका नाम मिला
विधि का नाम - निर्दिष्ट एपीआई में बुलाया जाने वाला विधि का नाम
JSON - विधि पैरामीटर के लिए JSON ऑब्जेक्ट का स्ट्रिंग प्रतिनिधित्व

कंकाल एपीआई

सर्वर-साइड कंकाल एपीआई में कई आधार वर्ग होते हैं:
index.php - सभी एपीआई कॉल के लिए Apache खातों में डायरेक्टरी इंडेक्स फाइल, यह पैरामीटर्स को पार करती है और एपीआई विधियों को कॉल करती है
MySQLiWorker - MySQLi के माध्यम से MySQL डेटाबेस के साथ काम करने के लिए एक एकल वर्ग
apiBaseCalss.php - सिस्टम में सभी API के लिए मूल वर्ग - प्रत्येक API को सही ढंग से काम करने के लिए इस वर्ग से विरासत में प्राप्त होना चाहिए
apiEngine.php - सिस्टम का मुख्य वर्ग - पास किए गए मापदंडों को पार करता है (index.php में उनके प्रारंभिक पार्सिंग के बाद) वांछित एपीआई वर्ग (आवश्यकता के माध्यम से) को जोड़ता है, इसमें वांछित विधि कहता है और JSON प्रारूप में परिणाम देता है
apiConstants.php - एपीआई कॉल और त्रुटियों को पारित करने के लिए स्थिरांक के साथ वर्ग
apitest.php - उत्पादन संस्करण में शामिल करने से पहले नए तरीकों का परीक्षण करने के लिए परीक्षण एपीआई

पूरा तंत्र इस प्रकार है:
हम सर्वर से अनुरोध करते हैं - उदाहरण के लिए, www.example.com/api/?apitest.helloWorld= {}
सर्वर की ओर, index.php फ़ाइल - पारित मापदंडों को पार्स करता है। Index.php हमेशा पारित पैरामीटर $ _REQUEST की सूची से केवल पहला तत्व लेता है - इसका मतलब है कि फॉर्म का एक डिज़ाइन www.example.com/api/?apitest.helloWorld= {} & apitest.helloestorld2 - केवल एपलस्ट में हेल्लोवर्ल्ड पद्धति को बुलाएगा। हेल्लोवर्ल्ड 2 मेथड कॉल विफल हो जाएगी

अब प्रत्येक के बारे में अधिक

मैंने काफी फाइलों को दस्तावेज करने की कोशिश की ताकि पाठ के तहत ज्यादा जगह न ले सके। हालांकि, उन फ़ाइलों में जहां कोई टिप्पणी नहीं है, मैं एक विवरण दूंगा।

index.php

जैसा कि मैंने पहले कहा था, यह अपाचे के लिए इनपुट इंडेक्स फ़ाइल है, जिसका अर्थ है कि यह www.example.com/api फॉर्म के सभी कॉल स्वीकार करेगा।

<?php header('Content-type: text/html; charset=UTF-8'); if (count($_REQUEST)>0){ require_once 'apiEngine.php'; foreach ($_REQUEST as $apiFunctionName => $apiFunctionParams) { $APIEngine=new APIEngine($apiFunctionName,$apiFunctionParams); echo $APIEngine->callApiFunction(); break; } }else{ $jsonError->error='No function called'; echo json_encode($jsonError); } ?>

सबसे पहले, हम सामग्री प्रकार - टेक्स्ट / html (फिर आप इसे स्वयं विधियों में बदल सकते हैं) और एन्कोडिंग - UTF-8 सेट कर सकते हैं।
फिर हम जाँचते हैं कि वे हमसे कुछ माँग रहे हैं। यदि नहीं, तो JSON को एक त्रुटि के साथ प्रिंट करें।
यदि अनुरोध पैरामीटर हैं, तो हम एपीआई इंजन फ़ाइल - apiEngine.php को शामिल करते हैं और पारित मापदंडों के साथ एक इंजन वर्ग बनाते हैं और एपीआई पद्धति को कॉल करते हैं।
हम लूप से बाहर निकलते हैं क्योंकि हमने फैसला किया था कि हम केवल एक कॉल की प्रक्रिया करेंगे।

apiEngine.php

दूसरा सबसे महत्वपूर्ण एपिंजाइन वर्ग है - यह एपी और उनके तरीकों को कॉल करने के लिए एक इंजन है।

 <?php require_once('MySQLiWorker.php'); require_once ('apiConstants.php'); class APIEngine { private $apiFunctionName; private $apiFunctionParams; //    API   API     static function getApiEngineByName($apiName) { require_once 'apiBaseClass.php'; require_once $apiName . '.php'; $apiClass = new $apiName(); return $apiClass; } // //$apiFunctionName -  API      apitest_helloWorld //$apiFunctionParams - JSON      function __construct($apiFunctionName, $apiFunctionParams) { $this->apiFunctionParams = stripcslashes($apiFunctionParams); //      [0] -  API, [1] -    API $this->apiFunctionName = explode('_', $apiFunctionName); } // JSON  function createDefaultJson() { $retObject = json_decode('{}'); $response = APIConstants::$RESPONSE; $retObject->$response = json_decode('{}'); return $retObject; } //       function callApiFunction() { $resultFunctionCall = $this->createDefaultJson();// JSON  $apiName = strtolower($this->apiFunctionName[0]);// API     if (file_exists($apiName . '.php')) { $apiClass = APIEngine::getApiEngineByName($apiName);//  API $apiReflection = new ReflectionClass($apiName);//       try { $functionName = $this->apiFunctionName[1];//    $apiReflection->getMethod($functionName);//   $response = APIConstants::$RESPONSE; $jsonParams = json_decode($this->apiFunctionParams);//    JSON  if ($jsonParams) { if (isset($jsonParams->responseBinary)){//    JSON,      zip, png  .  return $apiClass->$functionName($jsonParams);//   API }else{ $resultFunctionCall->$response = $apiClass->$functionName($jsonParams);//   API   JSON  } } else { //   JSON   $resultFunctionCall->errno = APIConstants::$ERROR_ENGINE_PARAMS; $resultFunctionCall->error = 'Error given params'; } } catch (Exception $ex) { //  $resultFunctionCall->error = $ex->getMessage(); } } else { //  API   $resultFunctionCall->errno = APIConstants::$ERROR_ENGINE_PARAMS; $resultFunctionCall->error = 'File not found'; $resultFunctionCall->REQUEST = $_REQUEST; } return json_encode($resultFunctionCall); } } ?>

apiConstants.php

इस वर्ग का उपयोग केवल स्थिरांक के लिए किया जाता है।

 <?php class APIConstants { //  -   JSON  public static $RESULT_CODE="resultCode"; // -      JSON   apiEngine public static $RESPONSE="response"; //  public static $ERROR_NO_ERRORS = 0; //    public static $ERROR_PARAMS = 1; //   SQL    public static $ERROR_STMP = 2; //    public static $ERROR_RECORD_NOT_FOUND = 3; //     .         public static $ERROR_ENGINE_PARAMS = 100; // zip  public static $ERROR_ENSO_ZIP_ARCHIVE = 1001; } ?>

MySQLiWorker.php

डेटाबेस के साथ काम करने के लिए एकल वर्ग। दूसरे शब्दों में, यह एक साधारण कुंवारा है - नेटवर्क पर ऐसे कई उदाहरण हैं।

 <?php class MySQLiWorker { protected static $instance; // object instance public $dbName; public $dbHost; public $dbUser; public $dbPassword; public $connectLink = null; //      new MySQLiWorker private function __construct() { /* ... */ } //      private function __clone() { /* ... */ } //     unserialize private function __wakeup() { /* ... */ } //   public static function getInstance($dbName, $dbHost, $dbUser, $dbPassword) { if (is_null(self::$instance)) { self::$instance = new MySQLiWorker(); self::$instance->dbName = $dbName; self::$instance->dbHost = $dbHost; self::$instance->dbUser = $dbUser; self::$instance->dbPassword = $dbPassword; self::$instance->openConnection(); } return self::$instance; } //            ->bind function prepareParams($params) { $retSTMTString = ''; foreach ($params as $value) { if (is_int($value) || is_double($value)) { $retSTMTString.='d'; } if (is_string($value)) { $retSTMTString.='s'; } } return $retSTMTString; } //   public function openConnection() { if (is_null($this->connectLink)) { $this->connectLink = new mysqli($this->dbHost, $this->dbUser, $this->dbPassword, $this->dbName); $this->connectLink->query("SET NAMES utf8"); if (mysqli_connect_errno()) { printf(" : %s\n", mysqli_connect_error()); $this->connectLink = null; } else { mysqli_report(MYSQLI_REPORT_ERROR); } } return $this->connectLink; } //    public function closeConnection() { if (!is_null($this->connectLink)) { $this->connectLink->close(); } } //     public function stmt_bind_assoc(&$stmt, &$out) { $data = mysqli_stmt_result_metadata($stmt); $fields = array(); $out = array(); $fields[0] = $stmt; $count = 1; $currentTable = ''; while ($field = mysqli_fetch_field($data)) { if (strlen($currentTable) == 0) { $currentTable = $field->table; } $fields[$count] = &$out[$field->name]; $count++; } call_user_func_array('mysqli_stmt_bind_result', $fields); } } ?>

apiBaseClass.php

खैर, यहां हम सिस्टम के सबसे महत्वपूर्ण वर्गों में से एक में आते हैं - सिस्टम में सभी एपीआई के लिए आधार वर्ग।

 <?php class apiBaseClass { public $mySQLWorker=null;//     //    function __construct($dbName=null,$dbHost=null,$dbUser=null,$dbPassword=null) { if (isset($dbName)){//          $this->mySQLWorker = MySQLiWorker::getInstance($dbName,$dbHost,$dbUser,$dbPassword); } } function __destruct() { if (isset($this->mySQLWorker)){ //     , $this->mySQLWorker->closeConnection(); //         } } //  JSON   function createDefaultJson() { $retObject = json_decode('{}'); return $retObject; } // JSON     MySQLiWorker function fillJSON(&$jsonObject, &$stmt, &$mySQLWorker) { $row = array(); $mySQLWorker->stmt_bind_assoc($stmt, $row); while ($stmt->fetch()) { foreach ($row as $key => $value) { $key = strtolower($key); $jsonObject->$key = $value; } break; } return $jsonObject; } } ?>

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

अपना खुद का एपीआई बनाएं

यह इस एपीआई की पूरी रीढ़ है। अब देखते हैं कि एपीटी नामक पहले एपीआई बनाने के उदाहरण का उपयोग करके यह सब कैसे उपयोग किया जाए। और इसमें कुछ सरल कार्य लिखें:
मापदंडों के बिना एक
वह मापदंडों और उन्हें हमारे साथ लौटाएगी, ताकि यह देखा जा सके कि वह उन्हें पढ़ती है
एक जो हमें बाइनरी डेटा लौटाएगा

और इसलिए हम निम्नलिखित सामग्री का apitest.php वर्ग बनाते हैं

 <?php class apitest extends apiBaseClass { //http://www.example.com/api/?apitest.helloAPI={} function helloAPI() { $retJSON = $this->createDefaultJson(); $retJSON->withoutParams = 'It\'s method called without parameters'; return $retJSON; } //http://www.example.com/api/?apitest.helloAPIWithParams={"TestParamOne":"Text of first parameter"} function helloAPIWithParams($apiMethodParams) { $retJSON = $this->createDefaultJson(); if (isset($apiMethodParams->TestParamOne)){ //   ,    $retJSON->retParameter=$apiMethodParams->TestParamOne; }else{ $retJSON->errorno= APIConstants::$ERROR_PARAMS; } return $retJSON; } //http://www.example.com/api/?apitest.helloAPIResponseBinary={"responseBinary":1} function helloAPIResponseBinary($apiMethodParams){ header('Content-type: image/png'); echo file_get_contents("http://habrahabr.ru/i/error-404-monster.jpg"); } } ?>

परीक्षण विधियों की सुविधा के लिए, मैं उन्हें उस पते पर जोड़ता हूं जिस पर मैं परीक्षण के लिए त्वरित अनुरोध कर सकता हूं।

और इसलिए हमारे पास तीन तरीके हैं

helloAPI

 function helloAPI() { $retJSON = $this->createDefaultJson(); $retJSON->withoutParams = 'It\'s method called without parameters'; return $retJSON; }

यह मापदंडों के बिना एक सरल विधि है। उनका GET पता www.example.com/api/?apitest.helloAPI= {} है

निष्पादन का परिणाम ऐसा पृष्ठ होगा (ब्राउज़र में)

helloAPIWithParams

यह विधि मापदंडों में ले जाती है। TestParamOne अनिवार्य है, और हम इसके लिए एक जांच करेंगे। यह इसे पारित नहीं करता है, फिर JSON एक त्रुटि के साथ जारी किया जाएगा

 function helloAPIWithParams($apiMethodParams) { $retJSON = $this->createDefaultJson(); if (isset($apiMethodParams->TestParamOne)){ //   ,    $retJSON->retParameter=$apiMethodParams->TestParamOne; }else{ $retJSON->errorno= APIConstants::$ERROR_PARAMS; } return $retJSON; }

निष्पादन परिणाम

helloAPIWithParams

helloAPIResponseBinary

और अंतिम helloAPIResponseBinary विधि - द्विआधारी डेटा लौटाएगा - एक पृष्ठ के बारे में एक हब की तस्वीर जो मौजूद नहीं है (उदाहरण के रूप में)

 function helloAPIResponseBinary($apiMethodParams){ header('Content-type: image/jpeg'); echo file_get_contents("http://habrahabr.ru/i/error-404-monster.jpg"); }

जैसा कि आप देख सकते हैं - ग्राफिक सामग्री को प्रदर्शित करने के लिए हेडर का प्रतिस्थापन है।
परिणाम इस तरह होगा

helloAPIResponseBinary

करने के लिए काम है

आगे के विकास के लिए, कॉल अनुरोधों के अधिकारों के विभेद को लागू करने के लिए उपयोगकर्ताओं को अधिकृत करना आवश्यक है - कुछ को स्वतंत्र छोड़ दिया जाना चाहिए, और कुछ केवल उपयोगकर्ता प्राधिकरण के साथ।

संदर्भ

परीक्षण के लिए, सभी फ़ाइलों को github - simpleAPI पर पोस्ट किया है

हम अपाचे, PHP और MySQL का उपयोग करके साइट के लिए अपना एपीआई लिखते हैं