在 Yii 2.0 上,RESTful 风格的 Web Service 服务的 API,Cookie支持的实现(不建议)

1、API面向的客户端为浏览器,公共参数:login_id、login_tid,其请求类型为 GET,其值来源于泛顶级域名下的Cookies,如图1

图1

2、就前端开发人员的要求,需要API的Cookie支持的实现(不建议),和Web应用不同,RESTful APIs 通常是无状态的,也就意味着不应使用sessions 或 cookies。

3、\api\behaviors\GlobalAccessBehavior.php,同时支持Cookie与GET,GET的优先级高于Cookie,代码如下

        /* 获取请求参数 */        $request = Yii::$app->request;
        $get = $request->get();
        if (!empty($get['login_id']) && !empty($get['login_tid'])) {
            $loginId = $get['login_id'];
            $loginTid = $get['login_tid'];
        } else {
            $response = Yii::$app->response;
            $acceptParams = $response->acceptParams;
            if (isset($acceptParams['cookie']) && $acceptParams['cookie'] = 'enable') {
                // 获取 cookie 集合
                $request->enableCookieValidation = false;
                $cookies = $request->cookies;
                if (isset($cookies['login_chinamcloud_id'])) {
                    $loginId = $cookies['login_chinamcloud_id']->value;
                    $get['login_id'] = $loginId;
                }
                if (isset($cookies['login_chinamcloud_tid'])) {
                    $loginTid = $cookies['login_chinamcloud_tid']->value;
                    $get['login_tid'] = $loginTid;
                }
                Yii::$app->request->setQueryParams($get);
                $request->enableCookieValidation = true;

                /* 未登录 */                if (empty($loginId) || empty($loginTid)) {
                    throw new HttpException(302, Yii::t('error', '20040'), 20039);
                }
            }
        }

4、在Postman中,设置Cookie的值,点击 Cookies 按钮,如图2

图2

5、添加域名:api.pcs-api.localhost,如图3

图3

6、添加Cookie,将:Cookie_12=value; path=/; domain=.api.pcs-api.localhost; 中的 Cookie_12=value 替换为对应的key=value,如图4

图4

7、Cookie_12=value 替换为对应的login_chinamcloud_id=e56db1b43546a110431ac38409ed8e9e,点击 Save 按钮,如图5

图5

8、再次添加 login_chinamcloud_tid=3eb9d8dd0328668be6b7536019a025b3; path=/; domain=.api.pcs-api.localhost;,添加完毕,关闭 MANAGE COOKIES 弹出框,如图6

图6

9、取消 URL Params 中的login_id、login_tid,再次执行请求,请求成功,成功获取到Cookies中的值,如图7

图7

10、切换至响应的Cookie中,发现已经存在对应的Cookie值,如图8

图8

永夜