這篇文章主要介紹了yii2的restful api路由實例詳解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨着小編來一起學習學習吧
yii\rest\UrlRule
使用yii\rest\UrlRule來自動映射控制器的 restful 路由,簡單快捷,缺點是必須得按規定好的方法名去寫業務。
映射的規則如下,當然,你可以修改源碼爲你的習慣:
public $patterns = [ 'PUT,PATCH {id}' => 'update', 'DELETE {id}' => 'delete', 'GET,HEAD {id}' => 'view', 'POST' => 'create', 'GET,HEAD' => 'index', '{id}' => 'options', '' => 'options', ];
除了被限制了HTTP動詞對應的方法名外,其他都很好用,比如pluralize是多麼的優雅啊,可以自動解析單詞的複數,laravel的話要一個個的去寫,反而有些不方便了
'urlManager' => [ 'enablePrettyUrl' => true, 'showScriptName' => false, 'enableStrictParsing' => true, 'rules' => [ [ 'class' => 'yii\rest\UrlRule', 'controller' => [ 'v1/user', 'v1/news', 'routeAlias' => 'v1/box' ], 'pluralize' => true ], ] ]
自定義路由
注意我路由裏很刻意的用了複數模式,但很雞肋,因爲一些單詞的複數並不是簡單的加個 s 就可以了。
'urlManager' => [ 'enablePrettyUrl' => true, 'showScriptName' => false, 'enableStrictParsing' => true, 'rules' => [ // 利用 module 做個版本號也是可以的 'GET <module:(v1|v2)>/<controller:\w+>s' => '<module>/<controller>/index', 'GET <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>' => '<module>/<controller>/view', 'POST <module:(v1|v2)>/<controller:\w+>s' => '<module>/<controller>/create', 'PUT,PATCH <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>' => '<module>/<controller>/update', 'DELETE <module:(v1|v2)>/<controller:\w+>s/<uid:\d+>' => '<module>/<controller>/delete', 'OPTIONS <module:(v1|v2)>/<controller:\w+>s' => '<module>/<controller>/options', '<controller:\w+>/<action:\w+>' => '<controller>/<action>',// normal '<module:\w+>/<controller:\w+>/<action:\w+>' => '<module>/<controller>/<action>',// module '/' => 'site/default',// default route ] ]
當然,這種高度動態的路由也可以寫的像laravel一樣半靜態。
'GET v1/children' => 'v1/child/index', 'GET v1/children/<uid:\d+>' => 'v1/child/view', 'POST v1/children' => 'v1/child/create', 'PUT,PATCH v1/children/<uid:\d+>' => 'v1/child/update', 'DELETE v1/children/<uid:\d+>' => 'v1/child/delete', 'OPTIONS v1/children' => 'v1/child/options',
如同laravel的如下
Route::get("/v1/children", "ChildController@index"); Route::post("/v1/children", "ChildController@create"); Route::put("/v1/children/{uid}", "ChildController@update"); Route::patch("/v1/children/{uid}", "ChildController@update"); Route::delete("/v1/children/{uid}", "ChildController@delete"); Route::options("/v1/children", "ChildController@options");
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。