Question

I have an REST API with Yii Framework based on:
http://www.yiiframework.com/wiki/175/how-to-create-a-rest-api/

I would like to add a version of the API in the Url Rules, like:

array('api/view', 'pattern'=>'api/<version:\d+>/<model:\w+>/<id:\d+>', 'verb'=>'GET'),

How should I do that?

Answer 1

If you want to use one controller you could do keep the rule as you have done:

array('api/view', 'pattern'=>'api/<version:\d+>/<model:\w+>/<id:\d+>', 'verb'=>'GET'),

And in the controller Action check the version:

public function actionView()
{
    // Check the version
    if($_GET['version'] == 1)
    {
       //do what you've got to do
    }
    else if ($_GET['version'] == 2)
    {
       //do what you've got to do
    }
}

Another solution is to use custom URL rule functionnality

• In the method “parseUrl” you check if the url is matching your rule
  (there is api/version/model/id) and if it is matching depending on the api version you redirect to the right controller (ex: apiV2/view)

Code:

public function parseUrl($manager,$request,$pathInfo,$rawPathInfo)
{
   if (preg_match('%^(api/(\d+))(/(\w+))(/(\d+))$%', $pathInfo, $matches))
        {
            // $matches[2] is the version and $matches[4] the model
            // If it matches we can check the version api and the model
            // If it's ok, set $_GET['model'] and/or $_GET['id']
            // and return 'apiVx/view'
        }
        return false;  // this rule does not apply
    }