Yii2.0 RESTful API 基础配置教程
创建api应用
通过拷贝原有的应用，重命名得到新的应用
安装完 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
拷贝backend目录，命名为api
应用配置
1. 数据库
打开 common\config\main-local.php,配置数据库连接信息
执行 migrate 数据库迁移
yii migrate
2.应用配置
打开api\config\main.php 修改id,controllerNamespace：
3. URL美化配置
打开common\config\main.php开启url路由美化规则
components' => [
// other config
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'enableStrictParsing' =>true,
'rules' => [],
]
],
4. 应用别名配置
打开common\config\bootstrap.php添加以下别名
Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');
5.服务器重写url配置
在应用入口同级增加.htaccess文件就好，我们以apache为例
<IfModule mod_rewrite.c>
<IfModule mod_negotiation.c>
Options -MultiViews -Indexes
</IfModule>
RewriteEngine On
# Handle Authorization Header
RewriteCond %{HTTP:Authorization} .
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
# Redirect Trailing Slashes If Not A Folder...
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_URI} (.+)/$
RewriteRule ^ %1 [L,R=301]
# Handle Front Controller...
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]
</IfModule>
Nginx 的配置
location / {
# Redirect everything that isn't a real file to index.php
try_files $uri $uri/ /index.php$is_args$args;
}
6. 启用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;
使用api
1 . 创建控制器，action
配置URL规则：添加入由，用user控制器
'urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
'pluralize' => false, //设置为false 就可以去掉复数形式了
],
],
]
说明：加入 'pluralize' => false, 就表示去掉复数形式了，再次强调不推荐
到此就成了一个 符合 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 支持的动词
api\controllers 新建一个User控制器，继承 yii\rest\ActiveController，命名为 UserController,代码如下：
namespace api\controllers;
use yii\rest\ActiveController;
class UserController extends ActiveController
{
public $modelClass = 'common\models\User';
}
这里创建 user控制器继承 yii\rest\ActiveController 并指定要操作的模型
2. 创建自定义的action,添加其他路由
修改 api\config\main.php，下面我们在user下添加一个send-email的动作
urlManager' => [
'enablePrettyUrl' => true,
'enableStrictParsing' => true,
'showScriptName' => false,
'rules' => [
['class' => 'yii\rest\UrlRule',
'controller' => 'user',
//'pluralize' => false, //设置为false 就可以去掉复数形式了
'extraPatterns'=>[
'GET send-email'=>'send-email'
],
],
],
]
说明：自己编写的任何 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,你应该具体情况具体对待,切记不要乱使用 任意加各种标识，请 遵循这些 规范 状态码
控制器代码：
<?php
namespace api\controllers;
use yii\rest\ActiveController;
class UserController 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']);
return $action;
}
public function actionIndex()
{
//你的代码
}
public function actionSendEmail() //假如是get请求
{
//业务逻辑
}
}
3. 如果访问我们上没配置路由规则
以使用 curl命令进行访问,命令如下:
curl -i -H "Accept:application/json" "http://localhost/users"
或者使用 POSTMAN等工具请求
