एक उदाहरण के रूप में Yii का उपयोग करके मोबाइल वेब सेवाओं का ऑटो-प्रलेखन

मुझे लगता है कि कई, विशेष रूप से छोटी, कंपनियां, जब एक ही ढांचे के साथ काम करते हैं, तो लगातार कुछ चीजें / एक्सटेंशन आदि लिखते हैं, जो वास्तव में उन समस्याओं को हल करते हैं जो वे अक्सर सामना करते हैं।



हमारे मामले में, यह ढांचा Yii है, और सबसे लोकप्रिय समस्याओं में से एक iOS / Android अनुप्रयोगों के लिए एक वेब सेवा का एक साथ विकास था।



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



हमने कैसे हल किया समस्या नीचे है।

वेब सेवा नियंत्रक विकास

एक नियम के रूप में, एक मोबाइल सेवा एक अलग परियोजना मॉड्यूल है। हमने वेब सेवा के साथ काम करने के लिए एक बुनियादी मॉड्यूल और एक बुनियादी नियंत्रक बनाया।



प्रमुख बातें नीचे हैं।

class VMJsonServiceController extends CController { public $documentationMode = false; protected $request = null; ... public function init() { if ($this->documentationMode) { return; } if (Yii::app()->request->isPostRequest) { $json = CJSON::decode(file_get_contents("php://input"), false); if (isset($json->request)) { $this->request = $json->request; } else { $this->respondWithError(VMServiceResponseCode::SERVICE_ERROR, 'There is no request node'); } } else { ... } } ... public function checkInputParameters($params = array()) { if ($this->documentationMode) { $exception = new VMDocumentationException(); $exception->parameters = VMObjectUtils::fromArray($params); throw $exception; } $this->checkObjectParameter($params, $this->request); } ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

सबसे "नमक" $documentationMode



में सटीक रूप से निहित है, लेकिन बाद में उस पर अधिक।

अब एक वास्तविक परियोजना से नियंत्रक के एक उदाहरण को देखते हैं, और एक साझा पुस्तकालय से नहीं।

 class UsersController extends VMJsonServiceController { ... public function actionSignUp() { $this->checkInputParameters(array( 'user' => array( 'email' => 'test@test.com', 'password' => '12345', 'phone' => array('optional', 'value' => '+7 999 998 76 54'), 'photos' => array('array', 'value' => array( 'file' => base64_encode('Image'), ) ) )); $email = $this->request->user->email; ... } ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

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



अब, वास्तव में, लेख की शुरुआत में चर्चा की गई थी - प्रलेखन के बारे में। सिद्धांत रूप में, checkInputPrameters विधि में सरणी इनपुट डेटा प्रारूप है, और वास्तव में, इसके आधार पर हम प्रलेखन उत्पन्न करते हैं, लेकिन लगातार हैंडल के साथ इसे उत्पन्न करना दिलचस्प और लंबा नहीं है। इसलिए, मॉड्यूल को अपने बारे में प्रलेखन उत्पन्न करें।



1. एक और नियंत्रक बनाना

Metadata



एक्सटेंशन का उपयोग करते हुए, यह सभी नियंत्रकों और क्रियाओं को दरकिनार करता है, और फिर विधि मापदंडों और सेवा प्रतिक्रियाओं के दृश्य प्रतिनिधित्व को प्रस्तुत करता है। यह उल्लेख किए गए checkInputParameters



विधि का उपयोग करके किया जाता है checkInputParameters

 class VMDocumentationController extends CController { ... //     ,      //     ""    private function getDefinition($class, $method) { try { $class->{$method}(); } catch (VMDocumentationException $e) { return (object) array( 'parameters' => $e->parameters ); } } ... }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2. हम आधार मॉड्यूल के कोड को सही करते हैं

 class VMJsonServiceModule extends CWebModule { public function init() { ... $this->controllerMap = array( 'documentation' => array( 'class' => 'VMDocumentationController' ) ); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

यह हमें क्या देता है? और तथ्य यह है कि एक ही यूआरएल पर iOS / Android प्रोग्रामर के पास किसी भी प्रोजेक्ट के लिए प्रलेखन है, केवल आधार परिवर्तन।

दस्तावेज़ीकरण कैसा दिखता है?

नीचे स्क्रीनशॉट की एक जोड़ी।



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











और अंत में - सभी स्रोत कोड यहां मिल सकते हैं । कुछ स्थानों में कोड भयानक है, कुछ स्थानों में यह बहुत ही भयानक है, हमारे पुस्तकालय में मोबाइल सेवा को छोड़कर जो कुछ भी है - आपको किसी की भी ज़रूरत नहीं है, लेकिन अगर कोई भी चीज़ पेश करनी है, तो पुल-अनुरोध आपकी मदद करेगा।



आपका ध्यान देने के लिए धन्यवाद।