使用 yii 实现 REST 风格接口

在 PHP 界有很多开发框架, yii 是其中一个比较优秀的框架。很多人都说 yii 比较复杂,先上手可以学习 ci 、 cakephp 什么的,其实我倒不这么认为, PHP 现在的框架一般整体的思路都差不多,都号称 MVC 那一套,其实关于是不是 MVC ,怎么个 MVC 法,这个话题太大,坑太深,不谈。其实,也就是说大家抽象的方式都类似,所以如果是要将 PHP 作为工具实用,而非研究,那就还是直接从牛人的肩膀上开始吧。当然,除了 yii 我另外还推荐 Laravel 框架。我个人感觉 php 的框架到这个地步就算是开始平稳了吧( yaf 另论)。总而言之,这些是废话,对于 PHP 这种,生而为 web ,死而为 web 的语言,实用、简单是根本。什么 dirty 不 dirty 、优雅不优雅的,非我等鼠辈所能 hold 住。

回到正题,现在我们利用 yii 框架来实现一个 REST 风格的调用接口。说到 REST ,现在大多的所谓 REST 风格,没有达到真正 REST 定义的那样,不过面向实用我们不必拘泥这些概念上的问题,如果有看官觉得觉得实现不够 REST 敬请拍砖,具体问题我们可以具体讨论。

首先做一下接口的 URL 规划,假设我们要面对的资源是 item ,现在我们暴露5个接口供其他应用调用,分别是:

对于所有 item 列表调用: GET /rest/item
对于某个 item 信息调用: GET /rest/item/(\d+)
创建一个 item: POST /rest/item
更新一个 item: PUT /rest/item/(\d+)
删除一个 item: DELETE /rest/item/(\d+)

然后根据规划在主配置里注册路由:

这里需要吐槽一下官方文档,路由配置这块基本什么说明都没写,比如rules数组中的配置数组,里的各种参数含义,比如verb,利用这个参数就能好好的绑定路由,不必再到controller里进行判断了。只有api参考里有些关于属性和方法的说明,主要信息来源还得靠在 Google 中自行寻觅。

然后开始编写 REST 的 Controller,安装 yii 框架的约定,我们建立 protected/controllers/RestController.php ,文件内容结构如下:

获取 item 列表的方法:

获取某一 item 的方法:

新建一个 Item 的方法:

更新一个 item 的方法:

删除某一 item 的方法:

辅助方法。

返回响应的方法:

获取 http 状态码的方法:

这样我们就用 yii 框架实现了一个简单的对应某个 model 的 REST 风格的 json 调用接口。这里只实现了一些大框架的东西,具体到验证,数据的再组织都没有涉及。不过使用框架的好处就是程序组织都已经有人帮你考虑好了,按照框架的开发方式,再加上一些需要的功能是很方便的。

发表评论