模块生成与配置
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'],
],
],
]
保存配置尝试访问配置模块是否配置成功
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 示例
列出所有用户
获取id为1用户的信息
新增一个用户
修改用户
删除id为48