Implement Restful Web Service In Modules

evstevemd · May 20, 2014, 6:28am

Kartik V:

Dave and others - this is not related to Yii REST API… but probably could help. The way in which you register modules in Yii config is important.

If you are configuring a module in Yii - you need to typically pass a class for the module in your configuration (this class should extend from \yii\base\Module).

So in your example where you are registering the module in your configuration, instead of just setting the basePath - you need to do this:
'modules' => [

   'v1' => [

   	'class' => 'app\modules\api\v1\Module',  // the name for your Module class

   ]

]
and your module class (Module.php) in app\modules\api\v1\
namespace app\modules\api\v1;

class Module extends \yii\base\Module

{

   public function init()

   {

   	parent::init();

   	// any other code

   }

}

I believe the base URL have to change also somehow. Or the pattern for that URL added to URL Manager.

kartikv · May 20, 2014, 6:31am

Once you register a module named v1 like below, Yii allows you to automatically access it as:

localhost/basic/v1/<controller>/<action> (for a basic app with prettyUrl set to true)




'modules' => [

   'v1' => [

        'class' => 'app\modules\api\v1\Module',  // the namespaced Module class

   ]

]

evstevemd · May 20, 2014, 6:38am

Kartik V:

Once you register a module named v1 like below, Yii allows you to automatically access it as:

localhost/basic/v1/<controller>/<action> (for a basic app with prettyUrl set to true)
'modules' => [

   'v1' => [

        'class' => 'app\modules\api\v1\Module',  // the namespaced Module class

   ]

]

Yum! I missed it