您的位置 首页 PHP

Yii2框架RESTful API 格式化响应,授权认证和速率限制三部分详解

之前写过一篇,今天接着来探究一下Yii2 RESTful的格式化响应,授权认证和速率限制三个部分

一、目录结构

先列出需要改动的文件。目录如下:

二、格式化响应

Yii2 RESTful支持JSON和XML格式,如果想指定返回数据的格式,需要配置yii\filters\ContentNegotiator::formats属性。例如,要返回JSON格式,修改frontend/controllers/BookController.php,加入红色标记代码:

返回XML格式:FORMAT_XML。formats属性的keys支持MIME类型,而values必须在yii\web\Response::formatters中支持被响应格式名称。

三、授权认证

RESTful APIs通常是无状态的,因此每个请求应附带某种授权凭证,即每个请求都发送一个access token来认证用户。

1.配置user应用组件(不是必要的,但是推荐配置):

  设置yii\web\User::enableSession属性为false(因为RESTful APIs为无状态的,当yii\web\User::enableSession为false,请求中的用户认证状态就不能通过session来保持)

  设置yii\web\User::loginUrl属性为null(显示一个HTTP 403 错误而不是跳转到登录界面)

具体方法,修改frontend/config/main.php,加入红色标记代码:

[

‘user’ => [
‘identityClass’ => ‘common\models\User’,’enableAutoLogin’ => true,’enableSession’ => false,’loginUrl’ => null,],…
]

2.在控制器类中配置authenticator行为来指定使用哪种认证方式,修改frontend/controllers/BookController.php,加入红色标记代码:

CompositeAuth::className(),’authMethods’ => [
/*下面是三种验证access_token方式*/
//1.HTTP 基本认证: access token 当作用户名发送,应用在access token可安全存在API使用端的场景,例如,API使用端是运行在一台服务器上的程序。
//HttpBasicAuth::className(),//2.OAuth 2: 使用者从认证服务器上获取基于OAuth2协议的access token,然后通过 HTTP Bearer Tokens 发送到API 服务器。
//HttpBearerAuth::className(),//3.请求参数: access token 当作API URL请求参数发送,这种方式应主要用于JSONP请求,因为它不能使用HTTP头来发送access token
//http://localhost/user/index/index?access-token=123
QueryParamAuth::className(),];
$behaviors[‘contentNegotiator’][‘formats’][‘text/html’] = Response::FORMAT_JSON;
return $behaviors;
}
}

3.创建一张user表

在common/models/User.php类中实现 yii\web\IdentityInterface::findIdentityByAccessToken()方法。修改common/models/User.php,加入红色标记代码::

$token]);
//throw new NotSupportedException(‘”findIdentityByAccessToken” is not implemented.’);
}

四、速率限制

为防止滥用,可以增加速率限制。例如,限制每个用户的API的使用是在60秒内最多10次的API调用,如果一个用户同一个时间段内太多的请求被接收,将返回响应状态代码 429 (这意味着过多的请求)。

1.Yii会自动使用yii\filters\RateLimiter为yii\rest\Controller配置一个行为过滤器来执行速率限制检查。如果速度超出限制,该速率限制器将抛出一个yii\web\TooManyRequestsHttpException。

修改frontend/controllers/BookController.php,加入红色标记代码:

RateLimiter::className(),’enableRateLimitHeaders’ => true,];
$behaviors[‘authenticator’] = [
‘class’ => CompositeAuth::className(),];
$behaviors[‘contentNegotiator’][‘formats’][‘text/html’] = Response::FORMAT_JSON;
return $behaviors;
}
}

2.在user表中使用两列来记录容差和时间戳信息。为了提高性能,可以考虑使用缓存或NoSQL存储这些信息。

修改common/models/User.php,加入红色标记代码:

allowance,$this->allowance_updated_at]; } // 保存请求时的UNIX时间戳。 public function saveAllowance($request,$action,$allowance,$timestamp) { $this->allowance = $allowance; $this->allowance_updated_at = $timestamp; $this->save(); } …. public static function findIdentityByAccessToken($token,$type = null) { //throw new NotSupportedException(‘”findIdentityByAccessToken” is not implemented.’); //findIdentityByAccessToken()方法的实现是系统定义的 //例如,一个简单的场景,当每个用户只有一个access token,可存储access token 到user表的access_token列中, 方法可在User类中简单实现,如下所示: return static::findOne([‘access_token’ => $token]); } …. }

以上所述是小编给大家介绍的Yii2框架RESTful API 格式化响应,授权认证和速率限制三部分详解 。脚本之家 jb51.cc 收集整理的教程希望能对你有所帮助,如果觉得脚本之家不错,可分享给好友!感谢支持。

关于作者: dawei

【声明】:金华站长网内容转载自互联网,其相关言论仅代表作者个人观点绝非权威,不代表本站立场。如您发现内容存在版权问题,请提交相关链接至邮箱:bqsm@foxmail.com,我们将及时予以处理。

热门文章