Yii2.0 RESTful API 快速搭建教程 [ 2.0 版本 ]
Yii2 RESTful API 实战教程
这篇说下yii2.0
开发 API
吧,使用 RESTful
API模式
安装Yii2.0
通过 Composer 安装
这是安装Yii2.0的首选方法。如果你还没有安装 Composer
,你可以按照这里的说明进行安装。
安装完 Composer
,运行下面的命令来安装 Composer Asset
插件:
php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"
安装高级的应用程序模板,运行下面的命令:
php composer.phar create-project yiisoft/yii2-app-advanced advanced 2.0.13
初始化高级模板
cd advanced
init
修改数据库连接属性
打开 common\config\main-local.php
,配置数据库连接信息
'db' => [
'class' => 'yii\db\Connection',
'dsn' => 'mysql:host=127.0.0.1;dbname=yiiapi',
'username' => 'root',
'password' => 'root',
'charset' => 'utf8',
],
执行 migrate
数据库迁移
yii migrate
拷贝backend目录,命名为api
打开api\config\main.php
修改id
,controllerNamespace
:
return [
'id' => 'app-api',
'basePath' => dirname(__DIR__),
'controllerNamespace' => 'api\controllers',
]
打开common\config\main.php
开启url
路由美化规则
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
],
],
打开common\config\bootstrap.php
添加以下别名
Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');
为什么要单独创建API应用
单独创建API应用,目的是便于维护,可以避免以下问题
- 配置的冲突
- 控制器的命名不便
- url美化规则冲突
- 分工明确
frontend
为前台目录;backend
为后台目录;api
为api目录
接下来打开 api\controllers
新建一个User控制器,继承 yii\rest\ActiveController
,命名为 UserController
,代码如下:
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extend extends ActiveController
{
public $modelClass = 'common\models\User';
}
这里创建 user
控制器继承 yii\rest\ActiveController
并指定要操作的模型
启用JSON 输入
配置 request
应用程序组件的 parsers
属性使用 yii\web\JsonParser
用于 JSON
输入
打开配置文件 api\config\main-local.php
修改为如下代码:
<?php
$config = [
'components' => [
'request' => [
// !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
'cookieValidationKey' => 'P0r2XoT9LCUnyVlSgxBbJOqQxdCJ3i29',
'parsers' => [
'application/json' => 'yii\web\JsonParser',
],
],
],
];
if (!YII_ENV_TEST) {
// configuration adjustments for 'dev' environment
$config['bootstrap'][] = 'debug';
$config['modules']['debug'] = [
'class' => 'yii\debug\Module',
];
$config['bootstrap'][] = 'gii';
$config['modules']['gii'] = [
'class' => 'yii\gii\Module',
];
}
return $config;
配置URL规则
为刚才的 user
控制器添加url美化规则
打开 api\config\main.php
修改 components
属性,添加下列代码:
...
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user'
],
],
]
...
ok,到此就成了一个 符合 RESTful
风格的API
看起来在控制器了什么也没有写,只是指定了一个模型,但是她的背后完成了很多的功能哦,列表如下:
GET /users
: 逐页列出所有用户HEAD /users
: 显示用户列表的概要信息POST /users
: 创建一个新用户GET /users/123
: 返回用户 123 的详细信息HEAD /users/123
: 显示用户 123 的概述信息PATCH /users/123
: and PUT /users/123: 更新用户123DELETE /users/123
: 删除用户123OPTIONS /users
: 显示关于末端 /users 支持的动词OPTIONS /users/123
: 显示有关末端 /users/123 支持的动词
如何访问呢
你可以使用 curl
命令进行访问,命令如下:
curl -i -H "Accept:application/json" "http://localhost/users"
命令行下还是比较麻烦的,也不方便测试,推荐使用 API
测试工具
这类的工具有很多,我就不一一列举了,这里推荐 Postman
,很好很强大,Chorme
也有插件,可以安装,这里我推荐直接下载软件安装调试,比较方便
你可能发现了 访问任何路由地址都是加的s
,users
, 为什么呢? 资源
,你要理解 资源
二字,既然是资源肯定是个集合,肯定有一大堆,所以要加上复数,我是这么理解的。
你说我就是不想加上s
,我就想采用http://localhost/user
这种方式来进行访问,好吧,可以,满足你,只是不推荐
继续打开配置文件api\config\main.php
修改刚才添加的 urlManager
如下:
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
'pluralize' => false, //设置为false 就可以去掉复数形式了
],
],
]
加入 'pluralize' => false,
就表示去掉复数形式了,再次强调不推荐
ok,在控制器中我们没有写任何一句代码,他就给我们生成许多方法,但是有时候我们可能需要修改一些代码,来达到我们想要的效果,比如连表查询,然后再返回数据
接下来我们就实现这样的功能:
打开刚才新建的user
控制器, 重写 action
方法:
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extend extends ActiveController
{
public $modelClass = 'common\models\User';
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action['index']);
unset($action['create']);
unset($action['update']);
unset($action['delete']);
}
public function actionIndex()
{
//你的代码
}
}
这样我们就可以重写他的代码了。哈哈
我们再新建一个自己的 action
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extend extends ActiveController
{
public $modelClass = 'common\models\User';
public function actions()
{
$action= parent::actions(); // TODO: Change the autogenerated stub
unset($action['index']);
unset($action['create']);
unset($action['update']);
unset($action['delete']);
}
public function actionIndex()
{
//你的代码
}
public function actionSendEmail() //假如是get请求
{
//业务逻辑
}
}
然后试着访问一下 http://localhost/users/send-email
,报错?找不到?
报错就对了,那是因为我们没有设置其他路由访问
修改 api\config\main.php
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
//'pluralize' => false, //设置为false 就可以去掉复数形式了
'extraPatterns'=>[
'GET send-email'=>'send-email'
],
],
],
]
接下来重新访问就没有问题了,ps:你自己编写的任何 action
都要在 extraPatterns
进行配置
差点忘了 状态码
这个东西,我们现在所有的东西返回来的都是一个 JSON
,加入没有数据局返回的是空的数组,所以这肯定不行啊,我们得加上 一些特定的状态码 来标识这些数据啊,怎么加?
继续修改 api\config\main.php
在 components
添加如下代码:
'response' => [
'class' => 'yii\web\Response',
'on beforeSend' => function ($event) {
$response = $event->sender;
$response->data = [
'success' => $response->isSuccessful,
'code' => $response->getStatusCode(),
'message' => $response->statusText,
'data' => $response->data,
];
$response->statusCode = 200;
},
],
这里统一使用 200
来表示,当然并不是所有的都是 200,你应该具体情况具体对待,切记不要乱使用 任意加各种标识,有时候你可能需要和一些前端讲道理了 所以请让他们务必 遵循这些 规范 状态码
是不是觉得还少了点什么?认证
对就是 认证
,就差 认证
就完美了,篇幅有限,内容多了反而影响阅读兴趣,下篇进行 认证
介绍
感谢以下,特别是 魏曦老师的视频教程
不足之处,欢迎指正
LaravelCode 北京
最后登录:14小时前
在线时长:190小时17分
- 粉丝47
- 金钱47220
- 威望110
- 积分50220
共 29 条评论
'enablePrettyUrl' => true,为什么我打开这个就用不了
检查下是否位置写错了?具体的报错信息是什么?
@LaravelCode 报错404,只要开启url美化就报错404,http://localhost/web/index.php , localhost指向frontend文件,注释掉//'enablePrettyUrl' => true,就能访问,我apache和nginx能切换使用,但是都不行.
@近距离接触 额,你检查下你的index.php 是不是做了隐藏,去掉index.php
@近距离接触 看下配置 web 服务器那里 https://laravelcode.cn/posts/8/yii-20-restful-api-basic-configuration-tutorial
@LaravelCode 谢谢大哥,可以啦。是这个.htaccess文件的问题,网上好多.htaccess我用了都不合适。
亲测去掉 common/config 下的 main-local.php 中的 urlManager 其他按照大神的教程,完全能实现
哈哈哈哈,感谢感谢
return [ 'id' => 'app-api', 'basePath' => dirname(__DIR__), 'controllerNamespace' => 'api\controllers', 'bootstrap' => ['log'], 'modules' => [], 'components' => [ 'request' => [ 'csrfParam' => '_csrf-backend', ], 'user' => [ 'identityClass' => 'common\models\User', 'enableAutoLogin' => true, 'identityCookie' => ['name' => '_identity-backend', 'httpOnly' => true], ], 'session' => [ // this is the name of the session cookie used for login on the backend 'name' => 'advanced-backend', ], 'log' => [ 'traceLevel' => YII_DEBUG ? 3 : 0, 'targets' => [ [ 'class' => 'yii\log\FileTarget', 'levels' => ['error', 'warning'], ], ], ], 'errorHandler' => [ 'errorAction' => 'site/error', ], /* 'urlManager' => [ 'enablePrettyUrl' => true, 'showScriptName' => false, 'rules' => [ ], ], */ ], 'params' => $params, ];
这里后面还有几个 backend,不知道需要同步更改吗?或者说让 api backend 他们用同一套规则
改不改都行,建议分开,不使用同一套规则
你加我微信吧 ,备注 YiiChina
760963254 害 忘记发微信号了....
http://www.api.com/v1/user 只能获取所有表的数据 后边加上s 就404,http://www.api.com/v1/users/1 也404 无法增删该查 是为啥呢
那你是否 把复数模式关掉了呢?关掉的话就不用加 s 了
@LaravelCode 现在的问题 是 增删查改不了 后面加参数就报404,不知道何从下手
@单人床 按照教程走了吗?贴出你的代码
@LaravelCode 而且我没关他复数形式 只能获取个所有列表其他都404
@单人床 我知道了,那是因为我的教程去掉了 其他的 action ,只重写了 index
unset($action['index']); unset($action['create']); unset($action['update']); unset($action['delete']);
如果 Yii 自身的能满足需要,那么就不要上面的代码。否则 就需要重写 每个 action 处理你自己的业务。
如果 本身的不能满足业务需求 ,就需要重写他的方法,你重新添加 其他action 即可,和 actionIndex() 一样
去掉复数化,不推荐。
这句话怎么理解?看你的项目需求了,默认肯定不能满足你的业务啊
本身 restful 就是在操作资源 ,理解下什么是 restful 就行
你可以看看 阮一峰老师 的这篇文章 https://www.ruanyifeng.com/blog/2011/09/restful.html
具体得按照业务来 ,没必要 完全依照 这个,正常的业务肯定是 多表关联,具体你还得细化 service 层, dao 层之类
@LaravelCode 好的。谢谢回复。
public $modelClass = 'common\models\User';
我这里加不加都不影响结果 为什么
应该是你的控制器继承错了 你的控制器可能是yii\rest\Controller,
你换成yii\rest\ActiveController, 如果不加 $modelClass 应该就会报错了
我觉得很好排查,你看下控制台网络里的响应
你没有初始化吧? 你看下api/web里面有index.php吗?
@LaravelCode 响应里面也是一片空白
@LaravelCode 初始化了,有index.php的
首先我不推荐你直接使用浏览器,换一个接口调试工具,
@LaravelCode 谢谢大神,我这边用了接口工具,就正常了
对,使用接口调试工具进行调试,不要用浏览器
谢谢大神的教程
请问大神,我这边出现一个问题,
在本地测试已经正常,API可以正常访问
但我部署到服务器上后,访问API,一片空白,打开网络,显示500错误。
请问这是什么问题呢
具体显示什么错误呢?
还有服务器环境是什么?Apache 还是Nginx
@LaravelCode 服务器和本地环境都是NGINX,配置文件除了ROOT和域名,其他也跟本地一样。
网站打开一片空白,错误信息我截图放在下面。谢谢大神
@鱼欲语雨 500之类的没有提示的错误,直接看服务器的日志,apache或者nginx的日志
谢谢大神,回去试试。之前按照官网的文档,有问题。
大神不敢当,有问题随时沟通就好,不过应该没啥大问题
继续修改 api\config\main.php 在 components 添加如下代码: 解释错误应该是api\config\main-local.php,亲测正确,放到你说的路径会报错
你放的位置有误吧?
我学yii也是看了魏曦老师的视频和网上看别人文章。 现在有个问题
我是在项目里写了一个基类
app\controllers\BaseController
然后所有的类都继承了这个基类,而这个基类是继承了yii\rest\ActiveController
然后我在这个基类里配置了cros和auth认证等一些东西。但是昨天发现一个场景就是有些类在数据库里是没有表的,也就是
$modelClass
不知道要写啥,然后就会报错。于是我继承了yii\rest\Controller
就没事了。所以我想问问,如果我不需要yii自带的那几个方法(index create view update ...)是不是我根本不需要继承
yii\reset\ActiveController
直接用yii\rest\Controller
就行了是的,可以直接继承
yii\rest\Controller
@LaravelCode Hi 正好借着楼,还想再请教一下跨域请求的问题。
我已经在基类的
behaviors方法
里配置了corsFilter
的操作,$behaviors['corsFilter'] = [ 'class' => Cors::class, 'except' => ['follow'], 'cors' => [ 'Origin' => ['*'], 'Access-Control-Request-Method' => ['GET', 'PUT', 'POST','DELETE', 'HEAD', 'OPTIONS'], 'Access-Control-Request-Headers' => ['*'], ] ];
现在的情况是请求一个比如POST接口
(user/follow)
的时候会提前以OPTIONS方式进行一次预检查,但是我的路由是'POST user/follow' => 'follow/index',
现在我想让所有的OPTIONS都通过,这个在YII2里有咩有可以配置的地方。难道我要把每个地址都变成
'POST,OPTIONS user/follow' => 'follow/index',
这样的吗?似乎我现在就是这样。。。。。。
@LaravelCode 哈哈 好吧!!!先这样来,等以后有好的处理方式我会来回帖的
嗯嗯,这样最好了,哈哈
http://localhost/admin/books
这样访问404,如果Apache根目录指向backend/web 可以访问到,http://localhost/books
但是 我还想用前台还是想指向frontend/web,但是这样就访问不到 backend里面的restful api?怎么办?大牛有时间指导一下不?
其实你应该配两个网址的,一个指向前台,一个指向后台,你可以通过指定不同的端口
controller重写的ations方法没有return
嗯,是的,是该return的,不过并不影响
@LaravelCode 有啊,没return的话就没必要unset了,比如我现在不想unset掉index方法
既然你想unset index ,为什么要写进去呢?直接不写不就好了
@LaravelCode 我想你应该没弄清楚我说的,比如我现在不想要
unset
掉index
方法,注释掉你这句unset($action['index']);
有用吗@zzzzym 你说得对,加上return吧
怎么启动这个项目进行测试呀?laravel 有
php artisan serve
,这个运行php yii serve
报:Document root "D:\Projects\php\advanced\console/web" does not exist.
怎么搞?谢谢我还真没有试过Yii框架内置服务器,你是通过什么装的,按照文档是 web 目录执行 php yii serve
刚才试了一下 直接执行
php yii serve
确实如此,行不通,但是其实
github
上已经有issue
了点击查看解决方案
解决方法:
yii serve --docroot="frontend/web/" #backend/web
访问不了首先这里就写错了代码
class UserController extend extends ActiveController
嗯,这里不小心多加了一个 extend 你把它去掉
没办法修改,舰长这货,时间一过就不让修改了,很是蛋疼
@LaravelCode 同样遇到这个 extend
@shuidaan 不小心多加了一个,去我的网站观看吧 。https://laravelcode.cn/posts/8/yii-20-restful-api-basic-configuration-tutorial
按上面的操作,一直提示404错误,请问一下htaccess这个文件放在哪个目录下面,里面的内容应该写什么,网上查了试了一下都不行。
web 目录下,和你的index.php 同级
提示404notfound,这是什么原因
@yufc URL规则是否开启? 加上index.php看下,
楼主忘记贴要在api/web中添加.htaccess文件了吧
这个因人而异,Apache 的话,使用.htaccess,nginx就不一样了
不是我吹,这是最好的restful教程 赞
没没没,夸张了,感觉有用就好