RBAC और परीक्षणों के साथ Yii फ्रेमवर्क पर RESTful API

1. मैंने जिन पहली समस्याओं का सामना किया उनमें से एक में विभिन्न संस्थाओं को संग्रहीत किया गया था। इस तरह के रिकॉर्ड प्राप्त करने के लिए, केवल मॉडल के नाम को इंगित करने के लिए पर्याप्त नहीं है, उदाहरण के लिए, यहां । इस तरह के तंत्र का एक उदाहरण है AuthItems तालिका, जिसका उपयोग AuthItems तंत्र में फ्रेमवर्क द्वारा किया जाता है (यदि कोई इससे परिचित नहीं है, तो इस विषय पर एक अद्भुत लेख है )। इसमें भूमिकाएं, संचालन और कार्य शामिल हैं जो कि type झंडे द्वारा निर्धारित किए गए हैं, और एपीआई के माध्यम से इन संस्थाओं के साथ काम करने के लिए मैं एक अलग यूआरएल का उपयोग करना चाहता था:
   

   GET: /api/authitems/?type=0 -
GET: /api/authitems/?type=1 -
GET: /api/authitems/?type=2 -

   
   लेकिन ऐसे:
   

   GET: /api/operations -
GET: /api/tasks -
GET: /api/roles -
   

   
   सहमत हूं, दूसरा विकल्प अधिक स्पष्ट और समझ में आता है, खासकर उस व्यक्ति के लिए जो इसमें रूपरेखा और आरबीएसी डिवाइस से परिचित नहीं है।
   
2. दूसरा महत्वपूर्ण अवसर एक डेटा खोज और फ़िल्टरिंग तंत्र है, जिसमें शर्तों को सेट करने और नियमों को संयोजित करने की क्षमता है। उदाहरण के लिए, मैं इस तरह के अनुरोध के एक एनालॉग को निष्पादित करने में सक्षम होना चाहता था:
   

    SELECT * FROM users WHERE (age>25 AND first_name LIKE '%alex%') OR (last_name='shepard'); 

   
   
3. कभी-कभी बनाने, अद्यतन करने, संग्रह को हटाने की क्षमता पर्याप्त नहीं है। यानी खोज और फ़िल्टरिंग का उपयोग करते हुए, एक क्वेरी में रिकॉर्ड की nth संख्या को बदलना। उदाहरण के लिए, आपको अक्सर किसी भी हालत में पड़ने वाले सभी रिकॉर्ड को हटाने या अपडेट करने की आवश्यकता होती है, और व्यक्तिगत प्रश्नों का उपयोग करना बहुत महंगा है।
   
4. एक अन्य महत्वपूर्ण बिंदु संबंधित डेटा प्राप्त करने की क्षमता थी। उदाहरण के लिए: अपने सभी कार्यों और कार्यों के साथ इन भूमिकाओं को प्राप्त करें।
   
5. बेशक, प्राप्त रिकॉर्ड ( limit ) की संख्या को सीमित करने, चयन की शुरुआत को स्थानांतरित करने ( offset ) को स्थानांतरित करने की क्षमता, और रिकॉर्ड के क्रम को क्रमबद्ध ( order by ) के बिना एपीआई के साथ कम से कम किसी तरह काम करना असंभव है। समूह ( group by ) में सक्षम होना भी अच्छा होगा।
   
6. प्रत्येक ऑपरेशन के लिए उपयोगकर्ता अधिकारों को सत्यापित करने में सक्षम होना महत्वपूर्ण है ( checkAccess विधि अभी भी उसी checkAccess में है)।
   
7. और अंत में, पूरे मामले को किसी भी तरह से जांचने की आवश्यकता है।
   

सबसे पहले, API क्लाइंट के लिए कैसा दिखता है।

पुनः प्राप्त रिकॉर्ड

GET: /roles -
GET: /roles/42 - id=42

खोजें और फ़िल्टर करें

• <: मुझे
• >: और
• <=: कम या इसके बराबर
• >=: से अधिक या बराबर
• <>: नहीं के बराबर
• =: बराबर

GET: /users?filter={"name":"alex"} - उपयोगकर्ताओं का नाम alex
GET: /users?filter={"name":"alex", "age":">25"} - alex और 25 वर्ष से अधिक आयु वाले उपयोगकर्ता
GET: /users?filter=[{"name":"alex"}, {"name":"dmitry"}] - जिन उपयोगकर्ताओं का नाम alex dmitry
GET: /users?search={"name":"alex"} - जिन उपयोगकर्ताओं के नाम के साथ सबस्टेनिंग alex (alexey, alexander, alex, आदि)

संबंधित डेटा के साथ काम करें

GET: /roles/42/operations - id = 42 साथ एक भूमिका से संबंधित सभी संचालन प्राप्त करें

एक से कई

GET: operations?filter={"role_id":"42"} - id = 42 साथ भूमिका से संबंधित सभी संचालन प्राप्त करें - id = 42

बहुतों को

POST: /products/42/feature/1 - उत्पाद विशेषता 1 साथ सहयोगी उत्पाद 42
GET: /products/42/feature/1 - उत्पाद 1 की विशेषता (प्रवेश तालिका से प्रविष्टि) प्राप्त करें

POST: /productfeatures - अनुरोध के शरीर में पैरामीटर product_id , feature_id , ordering और value को पास करते हुए, हम विशेषता और उत्पाद को लिंक करेंगे, जो मूल्य और क्रम क्रम को दर्शाते हैं।
GET: /productfeatures?filter={"product_id":"42"} - हमें विशेषताओं के साथ उत्पाद के सभी लिंक मिलते हैं। जवाब कुछ इस तरह लग सकता है:

 [ {"id":"12","feature_id":"1","product_id":"42","value":"33"}, {"id":"13","feature_id":"2","product_id":"42","value":"54"} ] 

PUT: /productfeatures/12 - id=12 साथ लिंक को बदलें

संबंधित डेटा पुनर्प्राप्त कर रहा है

GET: /productfeatures/12?with=product,feature - उत्पाद और विशेषताओं के साथ एक कनेक्शन प्राप्त करना। उदाहरण सर्वर प्रतिक्रिया:

 { "id":"12", "feature_id":"1", "product_id":"42", "value":"33", "feature":{"id":"1","name":"","unit":""}, "product":{"id":"42","name":"", ...}, } 

GET: /products/42?with=features - id=42 उत्पाद डेटा प्राप्त करना id=42 और सरणी में इसकी सभी विशेषताएं। उदाहरण सर्वर प्रतिक्रिया:

 { "id":"42", "name":"", "features":[{"id":"1","name":"","unit":""}, {"id":"2","name":"","unit":""}], ... } 

 { ..., "status":1, "statuses":{0:"  ", 1:" ", 2:" "}, ..., } 

डेटा डिलीट करना

DELETE: /role/42 - id=42
DELETE: /role -

DELETE: /role?filter={"name":"admin"} - "admin"

डेटा निर्माण

POST: /role -

 [ {"name":"admin"}, {"name":"guest"} ] 

डेटा परिवर्तन

PUT: /role/42 - 42

PUT: /role
अनुरोध शरीर में गुजर रहा है

 [ {"id":"1","name":"admin"}, {"id":"2","name":"guest"} ] 

आईडी 1 और 2 के साथ प्रविष्टियां बदली जाएंगी।

PUT: /user?filter={"role":"guest"}' - role=guest

रिकॉर्ड की सीमा, ऑफसेट और आदेश

GET: /users/?offset=10&limit=10
GET: /users/?order=id DESC
GET: /users/?order=id ASC

GET: /users/?order=parent_id ASC,ordering ASC

 { data:[ {id:1, name:"Alex", role:"admin"}, {id:2, name:"Dmitry", role:"guest"} ], meta:{ total:2, offset:0, limit:10 } } 

GET: roles?limit=5
Content-Range:items 0-4/10 - 0 4, 10.

Content-Range:items 0-9/10 - 0 9 10.

सर्वर पर कार्यान्वयन।

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

एपीआई मॉड्यूल नियंत्रक

actionView() - रिकॉर्ड प्राप्त करना
actionList() - रिकॉर्ड की एक सूची प्राप्त करना
actionCreate() - एक रिकॉर्ड बनाएँ
actionUpdate() - रिकॉर्ड परिवर्तन
actionDelete() - एक रिकॉर्ड हटाएं

 class RolesController extends ApiController { public function __construct($id, $module = null) { $this->model = new AuthItem('read'); $this->baseCriteria = new CDbCriteria(); $this->baseCriteria->addCondition('type='.AuthItem::ROLE_TYPE); parent::__construct($id, $module); } public function actionView(){ if(!Yii::app()->user->checkAccess('getRole')){ $this->accessDenied(); } $this->getView(); } public function actionList(){ if(!Yii::app()->user->checkAccess('getRole')){ $this->accessDenied(); } $this->getList(); } public function actionCreate(){ if(!Yii::app()->user->checkAccess('createRole')){ $this->accessDenied(); } $this->model->setScenario('create'); $this->priorityData = array('type'=>AuthItem::ROLE_TYPE); $this->create(); } public function actionUpdate( ){ if(!Yii::app()->user->checkAccess('updateRole')){ $this->accessDenied(); } $this->model->setScenario('update'); $this->priorityData = array('type'=>AuthItem::ROLE_TYPE); $this->update(); } public function actionDelete( ){ if(!Yii::app()->user->checkAccess('deleteRole')){ $this->accessDenied(); } $this->model->setScenario('delete'); $this->delete(); } public function getRelations() { return array( 'roleoperations'=>array( 'relationName'=>'operations', 'columnName'=>'operations', 'return'=>'array' ) ); } } 

 { bizrule: null description: "Administrator" id: "1" name: "admin" operations: [{...}, {...},...] type: "2" } 

 <?php class TagController extends ApiController { public function __construct($id, $module = null) { $this->model = new Tag('read'); parent::__construct($id, $module); } public function actionView(){ $this->getView(); } public function actionList(){ $this->getList(); } public function actionCreate(){ if(!Yii::app()->user->checkAccess('createTag')){ $this->accessDenied(); } $this->create(); } public function actionUpdate(){ if(!Yii::app()->user->checkAccess('updateTag')){ $this->accessDenied(); } $this->update(); } public function actionDelete(){ if(!Yii::app()->user->checkAccess('deleteTag')){ $this->accessDenied(); } $this->delete(); } } 

 array( 'limit' => 100, 'offset' => 0, 'order' => 'id ASC' ) 

 array( 'total'=>10, 'start'=>6, 'end'=>15 ) 

• getView ()
  जीईटी मापदंडों के अनुसार एक रिकॉर्ड के लिए खोज करता है। लिखने के मापदंडों की एक सरणी देता है या उपयोगकर्ता को डेटा भेजता है। यदि रिकॉर्ड नहीं मिला है, तो यह उपयोगकर्ता को 404 के जवाब कोड के साथ एक त्रुटि संदेश भेजता है या संबंधित त्रुटि जानकारी के साथ एक सरणी देता है। अनुरोध निष्पादित करने के बाद उचित मान के लिए स्थिति statusCode सेट करता है।
  

  getView(boolean $sendToEndUser = true, integer $id)
  $ SendToEndUser	बूलियन	ऑपरेशन पूरा होने के बाद उपयोगकर्ता को डेटा भेजना है या एरण के रूप में कार्रवाई का परिणाम वापस करना है।
  $ आई.डी.	पूर्णांक	प्रविष्टि का आईडी पैरामीटर। यदि पारित नहीं हुआ है, तो यह जीईटी मापदंडों से आबादी है।

  
  
• GetList ()
  जीईटी मापदंडों के अनुसार रिकॉर्ड की खोज करता है। पाया अभिलेखों की एक सरणी या एक खाली सरणी देता है।
  

  getList(boolean $sendToEndUser = true)
  $ SendToEndUser	बूलियन	ऑपरेशन पूरा होने के बाद उपयोगकर्ता को डेटा भेजना है या एरण के रूप में कार्रवाई का परिणाम वापस करना है।

  
  
• बनाएं ()
  अनुरोध निकाय से प्राप्त डेटा के साथ एक नया रिकॉर्ड बनाता है। यदि विशेषताओं का एक सरणी अनुरोध निकाय में प्रेषित किया जाता है, तो संबंधित रिकॉर्ड की संख्या पहचानी जाएगी। नए रिकॉर्ड की विशेषताओं के साथ एक सरणी देता है।
  उदाहरण के लिए:
  

   array( 'name'=>'Alex', 'age'=>'25' ) //    .  

  
  

   array( array( 'name'=>'Alex', 'age'=>'25' ), array( 'name'=>'Dmitry', 'age'=>'33' ) ) //     .  

  
  

  create(boolean $sendToEndUser = true)
  $ SendToEndUser	बूलियन	ऑपरेशन पूरा होने के बाद उपयोगकर्ता को डेटा भेजना है या एरण के रूप में कार्रवाई का परिणाम वापस करना है।

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

  PUT: users/1

  
  

   array( 'name'=>'Alex', 'age'=>'25' ) //        GET  

  
  

  PUT: users

  
  

   array( array( 'id'=>1, 'name'=>'Alex', 'age'=>'25' ), array( 'id'=>2, 'name'=>'Dmitry', 'age'=>'33' ) ) //        id     .      url 

  
  

  update(boolean $sendToEndUser = true, integer $id)
  $ SendToEndUser	बूलियन	ऑपरेशन पूरा होने के बाद उपयोगकर्ता को डेटा भेजना है या एरण के रूप में कार्रवाई का परिणाम वापस करना है।
  $ आई.डी.	पूर्णांक	प्रविष्टि का आईडी पैरामीटर। यदि पारित नहीं हुआ है, तो यह जीईटी मापदंडों से आबादी है।

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

  delete(boolean $sendToEndUser = true, integer $id)
  $ SendToEndUser	बूलियन	ऑपरेशन पूरा होने के बाद उपयोगकर्ता को डेटा भेजना है या एरण के रूप में कार्रवाई का परिणाम वापस करना है।
  $ आई.डी.	पूर्णांक	प्रविष्टि का आईडी पैरामीटर। यदि पारित नहीं हुआ है, तो यह जीईटी मापदंडों से आबादी है।

  
  

परीक्षण

 ... 'proddb'=>array( 'class'=>'CDbConnection', 'connectionString' => 'mysql:host=localhost;dbname=yiirestmodel', 'emulatePrepare' => true, 'username' => '', 'password' => '', 'charset' => 'utf8', ), //    'db'=>array( 'connectionString' => 'mysql:host=localhost;dbname=yiirestmodel-test', ), //    'authManager'=>array( 'connectionID'=>'proddb', //   ), ... 

 class UsersControllerTest extends ApiTestCase { public $fixtures = array( 'users'=>'User' ); public function testActionView(){ $user = $this->users('admin'); $response = $this->get('api/users/'.$user->id, array(), array('cookies'=>$this->getAuthCookies())); $this->assertEquals($response['code'], 200); $this->assertNotNull($response['decoded']); $this->assertEquals($response['decoded']['id'], $user->id); $this->assertArrayNotHasKey('password', $response['decoded']); $this->assertArrayNotHasKey('guid', $response['decoded']); } public function testActionList(){ $response = $this->get('api/users', array(), array('cookies'=>$this->getAuthCookies())); $this->assertEquals($response['code'], 200); $this->assertEquals(count($response['decoded']), User::model()->count()); } public function testActionCreate(){ $response = $this->post( 'api/users', array( 'first_name' => 'new_first_name', 'middle_name' => 'new_middle_name', 'last_name' => 'new_last_name', 'password' => 'new_user_psw', 'password_repeat' => 'new_user_psw', 'role' => 'guest', ), array('cookies'=>$this->getAuthCookies()) ); $this->assertEquals($response['code'], 200); $this->assertNotNull($response['decoded']); $this->assertArrayHasKey('id', $response['decoded']); $this->assertArrayNotHasKey('password', $response['decoded']); $this->assertNotNull( User::model()->findByPk($response['decoded']['id']) ); } } 

 public $loginUrl = 'api/login'; public $loginData = array('login'=>'admin', 'password'=>'admin'); 

 array( 'Date' => "Fri, 23 May 2014 12:10:37 GMT" 'Server' =>"Apache/2.4.7 (Win32) OpenSSL/1.0.1e PHP/5.5.9" ... ) 

 array('login'=>'admin', 'password'=>'admin'); 

• getAuthCookies ()
  एक प्राधिकरण अनुरोध का निष्पादन करता है।
  

  getAuthCookies(boolean $reload = false)
  $ पुनः लोड	बूलियन	.

  
  
• get()
  GET. .
  

  get( string $url, array $params = array(), array $options = array()){
  $url	string	Url
  $params	array	GET
  $options	array	, curl_setopt_array . cookies , (=>) .

  
  
• post()
  POST. .
  

  post( string $url, array $params = array(), array $options = array()){
  $url	string	Url
  $params	array
  $options	array	, curl_setopt_array . cookies , (=>) .

  
  
• put ()
  PUT पद्धति का उपयोग करके अनुरोध निष्पादित करता है। सर्वर प्रतिक्रिया मापदंडों के साथ एक सरणी देता है।
  मापदंडों का विवरण ApiTestCase :: post () देखें
  
• हटाएं ()
  DELETE पद्धति का उपयोग करके एक क्वेरी निष्पादित करें। सर्वर प्रतिक्रिया मापदंडों के साथ एक सरणी देता है।
  मापदंडों का विवरण ApiTestCase :: post () देखें
  

निष्कर्ष

पुनश्च