PHP编程：Yii2 RESTful中api的使用及开发实例详解

《PHP编程：Yii2 RESTful中api的使用及开发实例详解》要点：
本文介绍了PHP编程：Yii2 RESTful中api的使用及开发实例详解，希望对您有用。如果有疑问，可以联系我们。

相关主题：YII框架

PHP教程什么是RESTful风格的API

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

PHP教程Yii2如何实现RESTful风格的API

PHP教程1、建立单独的应用程序

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

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

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

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

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

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

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

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

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

PHP教程
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

PHP教程3、利用gii生成测试modules

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

PHP教程
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');

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

PHP教程

PHP教程

PHP教程

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

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

PHP教程4、重新配置控制器

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

PHP教程
<?php
namespace api\modules\v1\controllers;
use yii\rest\ActiveController;
class GoodsController extends ActiveController
{
public $modelClass = 'api\models\Goods';
}

PHP教程5、为Goods配置Url规则

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

PHP教程6、模拟请求操作

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

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

PHP教程

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

PHP教程当然,yii2还对该api封装了如下操作：

PHP教程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 支持的动词

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

PHP教程需要提醒的是,操作中还请细心且注意：

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

PHP教程7、关于授权认证

PHP教程为什么需要授权认证?这在一般的操作中是需要的.比如说用户要设置自己的信息.

PHP教程为了对yii2 restful授权认证说的更清楚,我们将会以两个两种不同的方法进行说明.

PHP教程首先需要开启认证：

PHP教程假设我们已经按照第3步创建了包含字段access-token的数据表user,而且利用gii上生成了相应的model和controller

PHP教程配置main.php文件

PHP教程
'components' => [
'user' => [ 
'identityClass' => 'common\models\User',
'enableAutoLogin' => true,
'enableSession'=>false
],
],

PHP教程为控制器配置authenticator行为指定认证方式

PHP教程
<?php
namespace api\modules\v1\controllers;
use yii\rest\ActiveController;
use yii\helpers\ArrayHelper;
use yii\filters\auth\QueryParamAuth;
class UserController extends ActiveController
{
public $modelClass = 'api\models\User';
public function behaviors() {
return ArrayHelper::merge (parent::behaviors(), [ 
'authenticator' => [ 
'class' => QueryParamAuth::className() 
] 
] );
}
}

PHP教程最后我们还需要在identityClass中实现findIdentityByAccessToken方法

PHP教程
public static function findIdentityByAccessToken($token, $type = null)
{
return static::findOne(['access_token' => $token, 'status' => self::STATUS_ACTIVE]);
}

PHP教程如此一来,我们先通过postman模拟不带access-token请求看结果

PHP教程
{
"name": "Unauthorized",
"message": "You are requesting with an invalid credential.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

PHP教程提示401 我们没有权限访问!

PHP教程我们在请求的链接上携带正确的access-token,认证通过后,控制器会再继续执行其他检查(频率限制、操作权限等),才可以返回正确的用户信息.

PHP教程需要提醒的是：通过url的形式对access-token传递存在一定的风险,有可能会造成数据的泄漏!一般而言,access-token需要放到HTTP头中进行传递!除非客户端的请求是jsonp格式的!

PHP教程8、速率限制

PHP教程速率限制,该操作完全也是出于安全考虑,我们需要限制同一接口某时间段过多的请求.

PHP教程速率限制默认不启用,用启用速率限制,yii\web\User::identityClass 应该实现yii\filters\RateLimitInterface,也就是说我们的common\models\User.php需要实现yii\filters\RateLimitInterface接口的三个方法,具体代码可参考：

PHP教程
use yii\filters\RateLimitInterface;
use yii\web\IdentityInterface;
class User extends ActiveRecord implements IdentityInterface, RateLimitInterface
{
// other code ...... 
// 返回某一时间允许请求的最大数量,比如设置10秒内最多5次请求(小数量方便我们模拟测试)
public function getRateLimit($request, $action){ 
return [5, 10]; 
}
// 回剩余的允许的请求和相应的UNIX时间戳数 当最后一次速率限制检查时
public function loadAllowance($request, $action){ 
return [$this->allowance, $this->allowance_updated_at]; 
} 
// 保存允许剩余的请求数和当前的UNIX时间戳
public function saveAllowance($request, $action, $allowance, $timestamp){ 
$this->allowance = $allowance; 
$this->allowance_updated_at = $timestamp; 
$this->save(); 
} 
}

PHP教程需要注意的是,你仍然需要在数据表User中新增加两个字段

PHP教程allowance：剩余的允许的请求数量

PHP教程allowance_updated_at：相应的UNIX时间戳数

PHP教程在我们启用了速率限制后,Yii 会自动使用 yii\filters\RateLimiter 为 yii\rest\Controller 配置一个行为过滤器来执行速率限制检查.

PHP教程现在我们通过postman请求v1/users再看看结果,会发现在10秒内调用超过5次API接口,我们会得到状态为429太多请求的异常信息.

PHP教程
{
"name": "Too Many Requests",
"message": "Rate limit exceeded.",
"code": 0,
"status": 429,
"type": "yii\\web\\TooManyRequestsHttpException"
}

PHP教程9、关于版本

PHP教程为了兼容历史版本而且考虑向后兼容性,我们在一开始操作的时候就以URL的方式实现了版本话,这里就不再进行阐述了.

PHP教程10、错误处理

PHP教程Yii的REST框架的HTTP状态代码可参考如下就好,没啥好说的

PHP教程200: OK.一切正常.
201: 响应 POST 请求时成功创建一个资源.Location header 包含的URL指向新创建的资源.
204: 该请求被成功处理,响应不包含正文内容 (类似 DELETE 请求).
304: 资源没有被修改.可以使用缓存的版本.
400: 错误的请求.可能通过用户方面的多种原因引起的,例如在请求体内有无效的JSON 数据,无效的操作参数,等等.
401: 验证失败.
403: 已经经过身份验证的用户不允许访问指定的 API 末端.
404: 所请求的资源不存在.
405: 不被允许的方法. 请检查 Allow header 允许的HTTP方法.
415: 不支持的媒体类型. 所请求的内容类型或版本号是无效的.
422: 数据验证失败 (例如,响应一个 POST 请求). 请检查响应体内详细的错误消息.
429: 请求过多. 由于限速请求被拒绝.
500: 内部服务器错误. 这可能是由于内部程序错误引起的.

转载请注明本页网址：
http://www.vephp.com/jiaocheng/5892.html