yii2的restful api路由实例详解


Posted in PHP onMay 14, 2019

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");

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
用PHP创建PDF中文文档
Oct 09 PHP
BBS(php &amp; mysql)完整版(一)
Oct 09 PHP
聊天室php&amp;mysql(一)
Oct 09 PHP
php mysql索引问题
Jun 07 PHP
同台服务器使用缓存APC效率高于Memcached的演示代码
Feb 16 PHP
PHP常用代码大全(新手入门必备)
Jun 29 PHP
利用curl 多线程 模拟 并发的详解
Jun 14 PHP
PHP跨平台获取服务器IP地址自定义函数分享
Dec 29 PHP
PHP+MYSQL中文乱码问题
Jul 01 PHP
PHP错误机制知识汇总
Mar 24 PHP
PHP获取网页所有连接的方法(附demo源码下载)
Mar 30 PHP
ThinkPHP5与单元测试PHPUnit使用详解
Feb 23 PHP
php的扩展写法总结
May 14 #PHP
PHP利用pdo_odbc实现连接数据库示例【基于ThinkPHP5.1搭建的项目】
May 13 #PHP
thinkPHP框架通过Redis实现增删改查操作的方法详解
May 13 #PHP
ThinkPHP3.2框架自带分页功能实现方法示例
May 13 #PHP
PHP使用Redis实现Session共享的实现示例
May 12 #PHP
如何让PHP编码更加好看利于阅读
May 12 #PHP
Yii2处理密码加密及验证的方法
May 12 #PHP
You might like
php的一些小问题
2010/07/03 PHP
php利用scws实现mysql全文搜索功能的方法
2014/12/25 PHP
PHP编写学校网站上新生注册登陆程序的实例分享
2016/03/21 PHP
javascript实现的动态文字变换
2007/07/28 Javascript
jquery在项目中做复选框时遇到的一些问题笔记
2013/11/17 Javascript
jquery与prototype框架的详细对比
2013/11/21 Javascript
JavaScript取得WEB安全颜色列表的方法
2015/07/14 Javascript
使用Jasmine和Karma对AngularJS页面程序进行测试
2016/03/05 Javascript
详解Vue学习笔记进阶篇之列表过渡及其他
2017/07/17 Javascript
bootstrap-table实现服务器分页的示例 (spring 后台)
2017/09/01 Javascript
Vue开发实现吸顶效果的示例代码
2018/08/21 Javascript
vue ssr 实现方式(学习笔记)
2019/01/18 Javascript
浅析python 内置字符串处理函数的使用方法
2014/06/11 Python
wxPython窗口的继承机制实例分析
2014/09/28 Python
Python实现将DOC文档转换为PDF的方法
2015/07/25 Python
Python的MongoDB模块PyMongo操作方法集锦
2016/01/05 Python
Python程序中的观察者模式结构编写示例
2016/05/27 Python
解析Python中的__getitem__专有方法
2016/06/27 Python
django轻松使用富文本编辑器CKEditor的方法
2017/03/30 Python
Python实现pdf文档转txt的方法示例
2018/01/19 Python
pandas把dataframe转成Series,改变列中值的类型方法
2018/04/10 Python
python遍历小写英文字母的方法
2019/01/02 Python
python 利用pywifi模块实现连接网络破解wifi密码实时监控网络
2019/09/16 Python
瑞贝卡·泰勒官方网站:Rebecca Taylor
2016/09/24 全球购物
财务与信息服务专业推荐信
2013/11/28 职场文书
幼儿园教师培训方案
2014/02/04 职场文书
婚礼主持结束词
2014/03/13 职场文书
新闻工作者先进事迹
2014/05/26 职场文书
校本教研活动总结
2014/07/01 职场文书
地震捐款倡议书
2014/08/29 职场文书
防灾减灾标语
2014/10/07 职场文书
无犯罪记录证明样本
2015/06/16 职场文书
运动会闭幕式主持词
2015/07/01 职场文书
担保公司2015年终工作总结
2015/10/14 职场文书
Spring Boot 启动、停止、重启、状态脚本
2021/06/26 Java/Android
收音机爱好者玩机13年,简评其使用过的19台收音机
2022/04/30 无线电