RBACおよびテストを使用したYiiフレームワーク上のRESTful API

1. 最初に遭遇した問題の1つは、1つのテーブルにさまざまなエンティティを格納することでした。 このようなレコードを取得するには、たとえばここに示すように、モデル名を単に示すだけでは不十分です 。 このようなメカニズムの1つの例は、RBACメカニズムのフレームワークで使用されるAuthItems
   
   
   
   テーブルです（誰かがそれに慣れていない場合、このトピックに関するすばらしい記事があります）。 type
   
   
   
   フラグによって決定されるロール、操作、およびタスクが含まれており、異なるURLを使用したいAPIを介してこれらのエンティティを操作します。
   
   

   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番目のオプションは、特にフレームワークとその中のRBACデバイスに精通していない人にとって、より明白で理解しやすいように見えます。
   
   
2. 2番目の重要な機会は、条件を設定し、ルールを結合する機能を備えたデータ検索およびフィルタリングメカニズムです。 たとえば、私はそのようなリクエストの類似物を実行できるようにしたかった：
   
   

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

   
   
   
3. コレクションを作成、更新、削除するだけでは不十分な場合があります。 つまり 再度検索とフィルタリングを使用して、1つのクエリでn番目のレコード数を変更します。 たとえば、あらゆる条件に該当するすべてのレコードを頻繁に削除または更新する必要があり、個々のクエリを使用するには費用がかかりすぎます。
   
   
4. もう1つの重要なポイントは、関連データを受信できることです。 たとえば、これらの役割とそのすべてのタスクと操作を取得します。
   
   
5. もちろん、受信したレコードの数を制限する（ limit
   
   
   
   ）、選択の開始をシフトする（ offset
   
   
   
   ）、レコードのソート順を指定する（ order by
   
   
   
   ）ことができないと、少なくとも何らかの形でAPIを操作することはできません。 また、グループ化（ group by
   
   
   
   ）できると便利です。
   
   
6. 各操作のユーザー権限を確認できることが重要です（ checkAccess
   
   
   
   メソッドcheckAccess
   
   
   
   まだ同じRBACにあります）。
   
   
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



ロールに属するすべての操作を取得します

1対多

GET: operations?filter={"role_id":"42"}



- id = 42



ロールに属するすべての操作を取得します

多対多

POST: /products/42/feature/1



製品42



を製品特性1



関連付けます

GET: /products/42/feature/1



製品1



の特性を取得します（ features



表から入力）

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", "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"} ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ID 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'),
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

APIモジュールコントローラー

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（）
  
  GETパラメーターに従ってレコードを検索します。 書き込みパラメーターの配列を返すか、ユーザーにデータを送信します。 レコードが見つからない場合、404の応答コードを含むエラーメッセージをユーザーに送信するか、対応するエラー情報を含む配列を返します。 リクエストの実行後にstatusCode
  
  
  
  プロパティを適切な値に設定します。
  
  

  getView(boolean $sendToEndUser = true, integer $id)
  $ sendToEndUser	ブール値	操作が完了した後にユーザーにデータを送信するか、アクションの結果を配列の形式で返すか。
  $ id	整数	エントリのidパラメータ。 渡されない場合、GETパラメーターから取り込まれます。

  
  
  
• getList（）
  
  GETパラメーターに従ってレコードを検索します。 見つかったレコードの配列または空の配列を返します。
  
  

  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	ブール値	操作が完了した後にユーザーにデータを送信するか、アクションの結果を配列の形式で返すか。

  
  
  
• 更新（）
  
  受信したGETパラメーターに従って見つかったレコードを更新します。 書き込みパラメーターの配列を返すか、ユーザーにデータを送信します。 レコードが見つからない場合、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	ブール値	操作が完了した後にユーザーにデータを送信するか、アクションの結果を配列の形式で返すか。
  $ id	整数	エントリのidパラメータ。 渡されない場合、GETパラメーターから取り込まれます。

  
  
  
• 削除（）
  
  受信したGETパラメーターに従って見つかったレコードを削除します。 リモートレコードパラメーターの配列を返すか、ユーザーにデータを送信します。 レコードが見つからない場合、応答コード404のエラーメッセージをユーザーに送信するか、対応するエラー情報を含む配列を返します。 idパラメーターが受信されない場合、すべてのレコードが削除されます。
  
  

  delete(boolean $sendToEndUser = true, integer $id)
  $ sendToEndUser	ブール値	操作が完了した後にユーザーにデータを送信するか、アクションの結果を配列の形式で返すか。
  $ id	整数	エントリのidパラメータ。 渡されない場合、GETパラメーターから取り込まれます。

  
  
  

テスト中

 ... '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)
  $reload	boolean	.

  
  
  
• 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	リクエストボディで渡されるリクエストパラメータの配列
  $オプション	配列	メソッドに置換されるオプションを要求しますcurl_setopt_array 。また、配列にはcookies 、リクエストヘッダーで送信するために、値がCookieの配列（名前=>値）である必要がある要素がある場合があります。

  
  
  
• put（）
  
  PUTメソッドを使用してリクエストを実行します。サーバー応答パラメーターを含む配列を返します。
  
  パラメータの説明は、ApiTestCase :: post（）を参照してください
  
  
• delete（）
  
  DELETEメソッドを使用してクエリを実行します。サーバー応答パラメーターを含む配列を返します。
  
  パラメーターの説明は、ApiTestCase :: post（）を参照してください
  
  

おわりに

PS