Yii2 Restful 快速构建 CURD

作者: ahcj_11 | 来源:发表于2017-08-21 21:54 被阅读1678次

Yii2 Restful 快速构建 CURD
Yii2 Restful 自定义方法
ThinkPHP5 快速curd
Java | Spring Data REST 快速构建 res
MixPHP 独特的SQL构建方式
restful设计
SpringBoot使用快速构建restful应用，你学废了吗
Spring-Boot-Api-Starter 基于Spring
SpringBoot2.0学习第一篇之构建RESTful Web
Yii2 Restful 支持分页

标签（空格分隔）： Yii2

1 什么是Restful

Restful 是一种软件架构风格，提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

Restful 的特征：

每一个URI代表一种资源

客户端和服务器之间，传递这种资源的某种表现层

客户端通过HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"

2 建立单独的应用程序

为了提高程序的可维护性，我们需要添加单独的 api 应用程序，并启用来做版本管理。详细参考 Yii2 Restful 添加Api应用

3 开启路由美化功能

文件路径： api/config/main.php

'components' => [
    ......

    'urlManager' => [
        'enablePrettyUrl' => true,// 启用美化URL  
         'enableStrictParsing' => true, // 是否执行严格的url解析  
         'showScriptName' => false,// 在URL路径中是否显示脚本入口文件
         'rules' => [],
    ]

......
],

4 启用 JSON 输入

文件路径： api/config/main.php

默认的 Restful API 将仅可以分辨 application/x-www-form-urlencoded 和 multipart/form-data 输入格式。
为了使 API 可以接收 JSON 格式的数据请求，配置 request 应用程序组件的 parsers 属性使用 yii\web\JsonParser 用于JSON输入：

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

5 使用 gii 生成独立模块,支持 api 版本控制

5.1 生成代码

module-gen.png

5.2 修改配置文件,支持 v1 模块

文件路径： api/config/main.php

<?php
......
'modules' => [
    'v1' => [
        'class' => 'api\modules\v1\Module',
    ],
],
......

6 使用 gii 生成基础代码，并修改

6.1 生成 model

2017-08-23 10-55-27 的屏幕截图.png

6.2 生成 controller

2017-08-23 10-56-44 的屏幕截图.png

6.3 修改模型

文件路径： api\models\Stock.php

<?php

namespace api\models;

use yii\db\ActiveRecord;

class Stock extends ActiveRecord
{
     public function rules()
    {
        return [
            [['symbol', 'code','name','ipo_date'], 'safe'],
        ];
    }
}

6.4 修改控制器

文件路径： api\modules\v1\controllers\StockController.php

<?php

namespace api\modules\v1\controllers;

class NewsController extends \yii\rest\ActiveController
{
    public $modelClass = 'api\models\Stock';
}

7 配置路由信息

文件路径： api/config/main.php

<?php

return [
    'enablePrettyUrl' => true,// 启用美化URL  
    'enableStrictParsing' => true, // 是否执行严格的url解析  
    'showScriptName' => false,// 在URL路径中是否显示脚本入口文件  
    'rules' => [
        [
            'class' => 'yii\rest\UrlRule',
            'controller' => 'v1/stock'
        ]
        
     ],
];

8 模拟请求

YII2常用的 Restful 请求有：

GET查看信息
POST创建信息
PUT更新信息
DELETE删除信息

GET 请求默认对应 index 或 view 方法，用于查看信息

8.1 查看列表

操作 : stock/index
URL : GET http://api.baojia.local/v1/stocks

2017-08-23 11-01-29 的屏幕截图.png

8.2 查看详细信息

操作 : stock/view
URL : GET http://api.baojia.local/v1/news/4

2017-08-23 11-02-39 的屏幕截图.png

8.3 新增信息

操作 : stock/create
URL : POST http://api.baojia.local/v1/stocks

2017-08-23 11-08-26 的屏幕截图.png

8.4 更新信息

操作 : stock/update
URL : PUT http://api.baojia.local/v1/stocks/3417

2017-08-23 11-11-01 的屏幕截图.png

8.5 删除信息

操作 : stock/update
URL : PUT http://api.baojia.local/v1/stocks/3417

2017-08-23 11-15-08 的屏幕截图.png

9 附数据表

-- MySQL dump 10.14  Distrib 5.5.52-MariaDB, for Linux (x86_64)
--
-- Host: localhost    Database: baojia
-- ------------------------------------------------------
-- Server version   5.5.52-MariaDB

/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
/*!40101 SET NAMES utf8 */;
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
/*!40103 SET TIME_ZONE='+00:00' */;
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

--
-- Table structure for table `news`
--

DROP TABLE IF EXISTS `news`;
/*!40101 SET @saved_cs_client     = @@character_set_client */;
/*!40101 SET character_set_client = utf8 */;
CREATE TABLE `news` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `title` varchar(50) NOT NULL,
  `thumb` varchar(250) DEFAULT NULL,
  `content` text,
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `updated_at` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;
/*!40101 SET character_set_client = @saved_cs_client */;

--
-- Dumping data for table `news`
--

LOCK TABLES `news` WRITE;
/*!40000 ALTER TABLE `news` DISABLE KEYS */;
INSERT INTO `news` VALUES (1,'1111',NULL,'1111','0000-00-00 00:00:00','0000-00-00 00:00:00'),(2,'2222',NULL,'1111','0000-00-00 00:00:00','0000-00-00 00:00:00'),(3,'1111','upload/火狐截图_2017-08-21T03-07-27.499Z.png','1111','0000-00-00 00:00:00','0000-00-00 00:00:00'),(4,'Hello World',NULL,NULL,'2017-08-21 10:25:17','0000-00-00 00:00:00');
/*!40000 ALTER TABLE `news` ENABLE KEYS */;
UNLOCK TABLES;
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

-- Dump completed on 2017-08-21 21:25:07