yii restful初探之curd

Bertha 。 2022-06-18 05:13 234阅读 0赞

## **模块生成与配置** ##

### **Gii 生成版本模块** ###

首先在 Gii 中生成我们需要的版本模块如下图所示  
![gii 生成版本模块][gii]

点击preview按钮生成模块

### **配置模块** ###

在配置文件中加入模块配置

'modules' => [
            'v1' => [
                'class' => 'app\modules\v1\Module',
    
            ],
        ],
    'components' => [
        'urlManager' => [
               'enablePrettyUrl' => true,
                'showScriptName' => false,
                'suffix' => '.html',
                'rules' => [
                    //'about/<id:\d+>' => 'site/about',
                    ['class' => 'yii\rest\UrlRule', 'controller' => 'v1/user'],
    
                    ],
                ],
      ]

保存配置尝试访问配置模块是否配置成功

![访问配置模块][SouthEast]

## **restful 准备工作** ##

### **第一个Controller** ###

<?php namespace app\modules\restful\controllers; use yii\rest\ActiveController; class UserController extends ActiveController { public $modelClass = 'app\modules\restful\models\User';//该控制器所对应的model }

### **model代码示例** ###

<?php
    
    namespace app\modules\restful\models;
    
    use Yii;
    
    /** * This is the model class for table "user". * * @property string $id * @property string $name * @property integer $age */
    class User extends \yii\db\ActiveRecord
    {
        /** * @inheritdoc */
        public static function tableName()
        {
            return 'user';
        }
    
        /** * @inheritdoc */
        public function rules()
        {
            return [
                [['age'], 'integer'],
                [['name'], 'string', 'max' => 255],
            ];
        }
    
        /** * @inheritdoc */
        public function attributeLabels()
        {
            return [
                'id' => 'ID',
                'name' => 'Name',
                'age' => 'Age',
            ];
        }
    }

## **CURD** ##

### **常见操作方法详解** ###

*  GET /users: 逐页列出所有用户
 *  HEAD /users: 显示用户列表的概要信息
 *  POST /users: 创建一个新用户
 *  GET /users/123: 返回用户 123 的详细信息
 *  HEAD /users/123: 显示用户 123 的概述信息
 *  PATCH /users/123 and PUT /users/123: 更新用户123
 *  DELETE /users/123: 删除用户123
 *  OPTIONS /users: 显示关于末端 /users 支持的动词
 *  OPTIONS /users/123: 显示有关末端 /users/123 支持的动词

### **CURD 示例** ###

列出所有用户  
![这里写图片描述][SouthEast 1]  
获取id为1用户的信息  
![这里写图片描述][SouthEast 2]  
新增一个用户  
![这里写图片描述][SouthEast 3]  
修改用户  
![这里写图片描述][SouthEast 4]  
删除id为48  
![这里写图片描述][SouthEast 5]

[gii]: /images/20220618/bbec764c44d941dc8d4399e02a22c1ea.png
[SouthEast]: /images/20220618/926a19c16599469da08d066621db6871.png
[SouthEast 1]: /images/20220618/65a0b341741f4d64ba4db8489d8cc537.png
[SouthEast 2]: /images/20220618/3f8a42ef3d5444bc80d8c0e600768ccd.png
[SouthEast 3]: /images/20220618/b8a4b87f5ba241768718158da28eff03.png
[SouthEast 4]: /images/20220618/5d6341a44cf046a4888ab672a6b39649.png
[SouthEast 5]: /images/20220618/919c1956c6fc4f5b91b36eb385fde26f.png