Yii2的restfull web服务配置

一.开启服务器的静态化

查看apache配置文件，找到下面代码

LoadModule rewrite_module modules/mod_rewrite.so

将其注释去掉；如果没有找到则添加进去；重启apache服务器。

然后在网站的根目录下面创建一个.htaccess文件，内容如下：

<IfModule mod_rewrite.c>
Options +FollowSymlinks
RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule . index.php
</IfModule>

二.创建一个模型

数据库准备一个名字为yii_nav的数据表,通过gii来创建Nav.php模型。

<?php

namespace app\models;

use Yii;
use yii\web\Link;
use yii\web\Linkable;
use yii\helpers\Url;

/**
 * This is the model class for table "yii_nav".
 *
 * @property integer $nav_id
 * @property integer $nav_pid
 * @property integer $nav_type
 * @property string $nav_icon
 * @property integer $nav_sort
 * @property string $homePage
 * @property integer $collapsed
 * @property integer $closeable
 * @property string $id
 * @property string $text
 * @property string $href
 * @property integer $status
 */
class Nav extends \yii\db\ActiveRecord implements Linkable
{
    /**
     * @inheritdoc
     */
    public static function tableName()
    {
        return 'yii_nav';
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['nav_pid', 'nav_type', 'nav_sort', 'collapsed', 'closeable', 'status'], 'integer'],
            [['nav_icon'], 'string', 'max' => 20],
            [['homePage', 'href'], 'string', 'max' => 100],
            [['id', 'text'], 'string', 'max' => 50]
        ];
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return [
            'nav_id' => 'Nav ID',
            'nav_pid' => 'Nav Pid',
            'nav_type' => 'Nav Type',
            'nav_icon' => 'Nav Icon',
            'nav_sort' => 'Nav Sort',
            'homePage' => 'Home Page',
            'collapsed' => 'Collapsed',
            'closeable' => 'Closeable',
            'id' => 'ID',
            'text' => 'Text',
            'href' => 'Href',
            'status' => 'Status',
        ];
    }

}

二.创建一个控制器

<?php

namespace app\controllers;

use yii\rest\ActiveController;

class NavController extends ActiveController
{   
    public $modelClass = 'app\models\Nav';
}

要注意的是，与普通控制器继承的类不同，此处继承ActiveController类。

三.配置URL规则

'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'enableStrictParsing' => true,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => ['nav']],
//             '<controller:\w+>/<id:\d+>' => '<controller>/view',
//             '<controller:\w+>/<action:\w+>/<id:\d+>' => '<controller>/<action>',
//             '<controller:\w+>/<action:\w+>' => '<controller>/<action>',
        ],
]

注意：将urlManager这段代码添加到components组件里面；enablePrettyUrl 为启用美化URL；showScriptName 在URL路径中是否显示脚本入口文件；enableStrictParsing 为是否执行严格的url解析；注释掉的三行代码，是yii最初版本的配置；对于yii2已经不需要了。也可以将注释去掉，将yii2的新增加的放到前面去，规避没有定义路由的页面的不能正常访问的问题。

四.开启JSON格式输出

'request' => [
    'parsers' => [
        'application/json' => 'yii\web\JsonParser',
    ]
]

注意：将request这段代码同样添加到components组件里面；

五.操作

特别注意：URLManager中controller定义的为nav，而我们访问时要加一个s字符操作。

• GET /navs: 按页列出所有nav中的数据;
• HEAD /navs: 显示nav列表的概要信息;
• POST /navs: 创建一个新的nav行;
• GET /navs/1: 返回第一个nav的详细信息;
• HEAD /navs/1: 显示第一个nav的概要信息;
• PATCH /navs/1 and PUT /users/123: 更新第一个nav信息;      注意：如果用Postman进行测试的话，contentType要选application/x-www-form-urlencoded操作
• DELETE /navs/1: 删除第一个nav;
• OPTIONS /navs: 显示支持的动作 /navs;
• OPTIONS /navs/1: 显示支持的动作 /navs/123.