这篇文章主要介绍了yii2的restful api路由实例详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。

yii\rest\UrlRule

使用yii\rest\UrlRule来自动映射控制器的 restful 路由，简单快捷，缺点是必须得按规定好的方法名去写业务。

映射的规则如下，当然，你可以修改源码为你的习惯：

1. public $patterns = [ 
2.   'PUT,PATCH {id}' => 'update', 
3.   'DELETE {id}' => 'delete', 
4.   'GET,HEAD {id}' => 'view', 
5.   'POST' => 'create', 
6.   'GET,HEAD' => 'index', 
7.   '{id}' => 'options', 
8.   '' => 'options', 
9. ]; 

除了被限制了HTTP动词对应的方法名外，其他都很好用，比如pluralize是多么的优雅啊，可以自动解析单词的复数，laravel的话要一个个的去写，反而有些不方便了

1. 'urlManager'  => [ 
2.   'enablePrettyUrl'   => true, 
3.   'showScriptName'   => false, 
4.   'enableStrictParsing' => true, 
5.   'rules'        => [ 
6.     [ 
7.       'class'   => 'yii\rest\UrlRule', 
8.       'controller' => [ 
9.         'v1/user', 
10.         'v1/news', 
11.         'routeAlias' => 'v1/box' 
12.       ], 
13.       'pluralize' => true 
14.     ], 
15.   ] 
16. ] 

自定义路由

注意我路由里很刻意的用了复数模式，但很鸡肋，因为一些单词的复数并不是简单的加个 s 就可以了。

1. 'urlManager'  => [ 
2.   'enablePrettyUrl'   => true, 
3.   'showScriptName'   => false, 
4.   'enableStrictParsing' => true, 
5.   'rules'        => [ 
6.     // 利用 module 做个版本号也是可以的 
7.     'GET <module:(v1|v2)>/<controller:\w+>s'         => '<module>/<controller>/index', 
8.     'GET <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>'    => '<module>/<controller>/view', 
9.     'POST <module:(v1|v2)>/<controller:\w+>s'        => '<module>/<controller>/create', 
10.     'PUT,PATCH <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>' => '<module>/<controller>/update', 
11.     'DELETE <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>'  => '<module>/<controller>/delete', 
12.     'OPTIONS <module:(v1|v2)>/<controller:\w+>s'       => '<module>/<controller>/options', 
13.  
14.     '<controller:\w+>/<action:\w+>'       => '<controller>/<action>',// normal 
15.     '<module:\w+>/<controller:\w+>/<action:\w+>' => '<module>/<controller>/<action>',// module 
16.     '/'                     => 'site/default',// default route 
17.   ] 
18. ] 

当然，这种高度动态的路由也可以写的像laravel一样半静态。

1. 'GET v1/children'         => 'v1/child/index', 
2. 'GET v1/children/<uid:\d+>'    => 'v1/child/view', 
3. 'POST v1/children'        => 'v1/child/create', 
4. 'PUT,PATCH v1/children/<uid:\d+>' => 'v1/child/update', 
5. 'DELETE v1/children/<uid:\d+>'  => 'v1/child/delete', 
6. 'OPTIONS v1/children'       => 'v1/child/options', 

如同laravel的如下

1. Route::get("/v1/children", "ChildController@index"); 
2. Route::post("/v1/children", "ChildController@create"); 
3. Route::put("/v1/children/{uid}", "ChildController@update"); 
4. Route::patch("/v1/children/{uid}", "ChildController@update"); 
5. Route::delete("/v1/children/{uid}", "ChildController@delete"); 
6. Route::options("/v1/children", "ChildController@options");

Tags: yii2 restful api

分享到：