白狼栈 2016-07-10 16:47:59 16103次浏览 5条评论 32 3 0

作者:白狼 出处:http://www.manks.top/yii2-restful-api.html 本文版权归作者,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。

什么是RESTful风格的API

对于各种客户端设备与服务端的通信,我们往往都通过API为客户端提供数据,提供某种资源。关于RESTful的概念,一查一大推,一两句也解释不清,姑且先按照我们通俗的理解:在众多风格、众多原则的API中,RESTful就是一套比较优秀的接口调用方式。

Yii2如何实现RESTful风格的API

1、建立单独的应用程序

为了增加程序的可维护性,易操作性,我们选择新建一套应用程序,这也是为了和前台应用、后台应用区分开操作。有些人要嚷嚷了,为啥非得单独搞一套呢?如果你就单纯的提供个别的几个h5页面的话,那就没有必要了,但事实往往是客户端要升级啊,要增加不同的版本啊,这就需要我们不但要后端不仅要增加一套单独的应用程序,我们还要增加各种版本去控制。

在WEB前端(frontend)和后端(backend)的同级目录,新建一个文件夹,命名api,其目录结构如下所示:

├─assets
│      AppAsset.php
├─config
│      bootstrap.php
│      main-local.php
│      main.php
│      params-local.php
│      params.php
├─runtime
└─web
    │ index.php
    ├─assets
    └─css

可以看出其目录结构基本上同backend没有其他差异,因为我们就是拷贝backend项目,只是做了部分优化。

2、为新建的api应用程序美化路由

首先保证你的web服务器开启rewrite规则,细节我们就不说了,不过这是前提。

接着配置api/config/main.php文件

'components' => [
    // other config
    'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'enableStrictParsing' =>true,
        'rules' => [],
    ]
],

最后只需要在应用入口同级增加.htaccess文件就好,我们以apache为例

Options +FollowSymLinks
IndexIgnore */*

RewriteEngine on

# if a directory or a file exists, use it directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

# otherwise forward it to index.php
RewriteRule . index.php

RewriteRule \.svn\/  /404.html
RewriteRule \.git\/  /404.html

3、利用gii生成测试modules

用了便于演示说明,我们新建一张数据表goods表,并向其中插入几条数据。

CREATE TABLE `goods` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `goods` VALUES ('1', '11111');
INSERT INTO `goods` VALUES ('2', '22222');
INSERT INTO `goods` VALUES ('3', '333');
INSERT INTO `goods` VALUES ('4', '444');
INSERT INTO `goods` VALUES ('5', '555');

接着我们先利用gii生成modules后,再利用gii模块,按照下图中生成goods信息

(图片参考原文)

现在,我们的api目录结构应该多个下面这几个目录

│
├─models
│      Goods.php
│
├─modules
│  └─v1
│      │  Module.php
│      │
│      ├─controllers
│      │      DefaultController.php
│      │      GoodsController.php
│      │
│      └─views
│          └─default
│                  index.php

4、重新配置控制器

为了实现restful风格的api,在yii2中,我们需要对控制器进行一下改写

<?php

namespace api\modules\v1\controllers;

use yii\rest\ActiveController;

class GoodsController extends ActiveController
{
    public $modelClass = 'api\models\Goods';
}

5、为Goods配置Url规则

'rules' => [
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => ['v1/goods']
    ],
]

6、模拟请求操作

经过上面几个步骤,到此我们已经为goods成功创建了满足restful风格的api了。为了更好更方便的演示,我们借助工具postman进行模拟请求。

为了见证一下我们的操作,我们用postman请求一下GET /v1/goods看看结果如何:

(postman截图见原文)

从上面截图中可以清楚的看到,GET /v1/goods 已经能够很方便的获取我们表中的数据了。

当然,yii2还对该api封装了如下操作:

  • 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 支持的动词

不信的话我们可以利用postman发送一个post请求到/v1/goods,我们会发现成功创建了一个新的商品。

需要提醒的是,操作中还请细心且注意:

如果你的控制器末端不是复数(比如是blog非blogs)请保证请求的时候是复数!这是因为在RESTful架构中,网址中只能有名词而不能包含动词,名词又往往与数据表相对应,数据表呢又是一个“集合”,因此该名词往往是复数的形式。

7、关于授权认证

[考虑目前国内网站大部分采集文章十分频繁,更有甚者不注明原文出处,原作者更希望看客们查看原文,以防有任何问题不能更新所有文章,避免误导!]

查看原文

Restful yii2 CURL
  • 评论于 2016-07-12 09:06 举报

    白狼的网站之前的样式还好一点,现在不好看。

    1 条回复
    评论于 2016-07-12 12:07 回复

    文章好才是真的好!

  • 评论于 2016-09-15 16:02 举报

    如果不用model 传输的是文件怎么办?

    1 条回复
    评论于 2017-06-12 20:30 回复

    extends yii\rest\Controller

  • 评论于 2016-09-27 15:03 举报

    这种会不会太局限,比如,一个数据源可能是有几方数据组合而成的,这种类似官方文档的demo,该怎么解决呢?

    1 条回复
    评论于 2016-11-03 11:43 回复

    代码的业务逻辑该怎么写没有影响

  • 评论于 2017-02-09 16:37 举报

    完整的代码 大神不够详细

    8 条回复
    评论于 2017-02-09 17:11 回复

    比如,哪里写的比较粗糙?

    评论于 2017-02-09 21:20 回复

    大神,主要新手看不明白,新手需耍成功的例子,在线等求求

    评论于 2017-02-09 21:32 回复

    有一个授权认证的例子,不知道你喜欢不 http://t.cn/RMXcJwA

    评论于 2017-02-10 17:51 回复

    大神 我按大神的方法做了两天了 都没成功

    评论于 2017-02-10 18:02 回复

    我需要完整的例子 不是那些命令什么的 因为初学者一点错误就会迷茫 这个也是yii的悲哀

    评论于 2017-02-13 19:13 回复

    这个大神竟糊弄人 大家注意了

    评论于 2017-02-13 21:21 回复

    呵呵

    评论于 2017-09-13 14:30 回复

    给你完整的例子还不如你提需求,我给你免费打工。可好???伸手党!!!!!!

  • 评论于 2017-03-28 17:11 举报

    需要提醒的是,操作中还请细心且注意:

    如果你的控制器末端不是复数(比如是blog非blogs)请保证请求的时候是复数!

    这个是强制性的要求吗?如果结尾不是s,如下图

                        'class' => 'yii\rest\UrlRule',
                        'controller' => ['v1/resta']       
    

    这种情况只能GET访问http://api.com/v1/resta,
    其它的都失败。改成

                        'class' => 'yii\rest\UrlRule',
                        'controller' => ['v1/restas']
    

    然后访问http://api.com/v1/restas,测试GET,POST,PUT,PATCH,DELETE都成功了

    1 条回复
    评论于 2017-03-28 17:20 回复

    Yii 将在末端使用的控制器的名称自动变为复数
    经测试第一种配置没啥错误,只是访问方式还是要按照下面的来就好了

您需要登录后才可以评论。登录 | 立即注册