composer安装开发Yii2.0 RESTful API

最新推荐文章于 2019-03-24 17:07:52 发布

kenven+

最新推荐文章于 2019-03-24 17:07:52 发布

阅读量449

点赞数

分类专栏：框架 php

本文链接：https://blog.csdn.net/Lkeven/article/details/86571360

版权

php 同时被 2 个专栏收录

24 篇文章 1 订阅

订阅专栏

框架

3 篇文章 1 订阅

订阅专栏

通过composer安装yii2.0框架开发restful api

参考教程(感谢!):
Yii 中文网
 魏曦教你学
 PHP同行:LaravelCode

开发环境:windows下phpstudy
开发工具:composer postman

一:安装配置composer

composer:是 PHP 用来管理依赖（dependency）关系的工具。你可以在自己的项目中声明所依赖的外部工具库（libraries），Composer 会帮你安装这些依赖的库文件。
安装地址

安装步骤省略(下载完成一路next…)
安装完成后,打开cmd命令行窗口,输入composer 显示如下安装成功安装composer成功
接下来配置composer修改国内镜像,composer的软件仓库在国外,我们修改为内镜像仓库,提高使用速度

composer config -g repositories.packagist composer https://packagist.phpcomposer.com

二:composer安装YII2.0框架

参考YII框架中文网
选择一开发目录 cmd下进入

安装完 Composer，运行下面的命令来安装 Composer Asset 插件:
composer global require "fxp/composer-asset-plugin:^1.2.0"
安装基本的应用程序模板，运行下面的命令：
composer create-project yiisoft/yii2-app-basic basic 2.0.13
安装高级的应用程序模板，运行下面的命令：
composer create-project yiisoft/yii2-app-advanced advanced 2.0.13

三:开发restful API

下载YII2.0高级模板后进行初始化:

cd advanced
init

修改数据库连接属性
打开 common\config\main-local.php,配置数据库连接信息

'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=127.0.0.1;dbname=yiiapi',
            'username' => 'root',
            'password' => 'root',
            'charset' => 'utf8',
        ],

执行 migrate 数据库迁移
yii migrate

拷贝backend目录，命名为api
打开api\config\main.php 修改id,controllerNamespace

return [
    'id' => 'app-api',
    'basePath' => dirname(__DIR__),
    'controllerNamespace' => 'api\controllers',
]

打开common\config\main.php开启url路由美化规则

        'urlManager' => [
            'enablePrettyUrl' => true,//开启url美化
            'enableStrictParsing' => true,//是否开启严格解析路由
            'showScriptName' => false,//是否或略脚本名index.php
              'rules' => [
            ],
        ],

打开common\config\bootstrap.php添加以下别名
Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');

这样YII框架具备了:frontend前台目录；backend后台目录；api接口目录

接下来打开 api\controllers 新建一个User控制器，继承yii\rest\ActiveController，命名为 UserController 代码:
这里创建 user控制器继承 yii\rest\ActiveController并指定要操作的模型

<?php
namespace api\controllers;
use yii\rest\ActiveController;

class UserController extend extends ActiveController
{
    public $modelClass = 'common\models\User';
    
}

为user控制器添加url美化规则
打开api\config\main.php 修改 components属性，添加下列代码:
!!!控制器中 action 都要在 extraPatterns 进行配置

......
'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule', 
        'controller' => 'user'
         //'pluralize' => false, //去掉复数形式，再次强调不推荐
        ],
    ],
]
......

在控制器中虽然我们没有写任何一句代码，默认生成许多方法，但是有时候我们可能需要修改一些代码，来达到我们想要的效果，比如连表查询，然后再返回数据,则需要重写方法代码如下:

<?php
namespace api\controllers;

use Yii;
use yii\rest\ActiveController;
use yii\web\Response;
use api\models\LoginForm;

class UserController extends ActiveController
{
    public $modelClass = 'common\models\User';
    //默认有5个方法：index、view、create、update、delete、options；
    public function actions()
    {
        $action= parent::actions(); // TODO: Change the autogenerated stub
        unset($action['index']);
        unset($action['create']);
        unset($action['update']);
        unset($action['delete']);
    }

    public function behaviors()
    {
    $behaviors = parent::behaviors();
    //定义返回格式是：JSON
    $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
    return $behaviors;
    }

    public function actionIndex()
    {
        //你的代码 例如:
        return 'aaa';
    }

    //返回的状态码/内容可自行设定 例如在控制器中这样使用:
    public function actionA()
    {
        $response = Yii::$app->response;
        $response->setStatusCode(543);
        return [
            'msg' => '该方法不存在!'
        ];
    }



    /*
    ESTful 风格的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 支持的动词
     */
}

为该API项目配置本地访问域名:

---host文件:
127.0.0.1 yiiapi.com

---vhosts.conf:
<VirtualHost *:80>
    DocumentRoot "D:\phpStudy\PHPTutorial\WWW\code\advanced\api\web"  PS: api所在本地目录
    ServerName yiiapi.com
</VirtualHost>

通过域名访问user控制器中A方法:
http://yiiapi.com/user/a 报错:Not Found (#404)

users 不是 user 任何路由地址都是加的s,users ，restfulAPI: 资源既然是资源肯定是个集合
编写的任何 action 都要在 extraPatterns 进行配置

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule', 
        'controller' => 'user'
         //'pluralize' => false, //去掉复数形式，再次强调不推荐
            'extraPatterns'=>[ //控制器中 action 都要在 extraPatterns 进行配
                        'GET a'=> 'a',
                    ],
        ],
    ],
]

重新访问 http://yiiapi.com/users/a

开启rewrite（伪静态）

1.httpd.conf配置
#LoadModule rewrite_module modules/mod_rewrite.so  去掉#

2.httpd.vhosts.conf配置
AllowOverride All

设置完成重启,PHP项目就开启了rewrite模块，可以使用PHP框架路由模式来进行其指定的路由访问

开启url美化

一: 配置http服务器
Apache:
在入口文件（index.php）所在的目录下新建一个文本文件，接着另存为.htaccess，用编辑器打开此文件加入：
RewriteEngine on
# 如果文件存在，就直接访问文件，不进行下面的RewriteRule
RewriteCond %{REQUEST_FILENAME} !-f
# 如果是一个目录或者文件，就访问目录或文件
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [L,E=PATH_INFO:$1]

Nginx:
在nginx配置文件（我本地是/conf/vhosts/test.conf文件）中加入：
location/{
    try_files $uri $uri/ /index.php?$query_string;
}
整个server配置类似：
server {
        listen80;
        server_name  test.yii.com;

        root "/Projects/yii/web";
        location / {
            index  index.html index.htm index.php;
            try_files $uri $uri/ /index.php?$query_string;
        }

        error_page /50x.html;
        location = /50x.html {
            root   html;
        }

        location~ \.php(.*)$ {
            fastcgi_pass 127.0.0.1:9000;
            fastcgi_index  index.php;
            fastcgi_split_path_info ^((?U).+\.php)(/?.*)$;
            fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
            fastcgi_param  PATH_INFO  $fastcgi_path_info;
            fastcgi_param  PATH_TRANSLATED  $document_root$fastcgi_path_info;
            include        fastcgi_params;
        }
    }
    
二 :配置yii

打开config目录下的web.php，在$config = [ 'components'=>[] ]中加入以下内容：
'urlManager' => [
    //开启url美化
    'enablePrettyUrl' => true,
    //隐藏index.php
    'showScriptName' => false,
    //禁用严格匹配模式
    'enableStrictParsing' => false,
    //url后缀名称
    'suffix'=>'.html',
    //url规则
    'rules' => [
        //post后面跟上数字的url，则将数字赋给id参数，然后传递给 post/view，实际上访问的是 post/view?id=XXX
        'post/<id:\d+>'=>'post/view'
    ]
],

三、重启http服务器
注意事项:
http服务器中配置的虚拟域名必须直接指向入口文件所在目录，否则在url省略index.php的情况下，http服务器无法正确访问到项目。

接口返数据状态码设置
修改 api\config\main.php 在 components 添加如下代码:

'response' => [
            'class' => 'yii\web\Response',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                $response->data = [
                    'success' => $response->isSuccessful,
                    'code' => $response->getStatusCode(),
                    'message' => $response->statusText,
                    'data' => $response->data,
                ];
                $response->statusCode = 200;
            },
        ],

YII启用JSON 输入
打开配置文件api\config\main-local.php 修改为如下代码:

<?php

$config = [
    'components' => [
        'request' => [
             !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
            'cookieValidationKey' => 'VkmY8edPvHptf2bPBvnJBokoSzb0KNae',
            //-----在这里-----
            'parsers' => [
                'application/json' => 'yii\web\JsonParser',

            ],
        ],
    ],
];

YII设置方法返回格式
在所需要的控制器中设置

    public function behaviors()
    {
    $behaviors = parent::behaviors();
   // 定义返回格式是：JSON
    $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
    return $behaviors;
    }

YII的REST框架的HTTP状态代码可参考如下:

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: 内部服务器错误。 这可能是由于内部程序错误引起的。

四:API认证

和Web应用不同，RESTful APIs 通常是无状态的，也就意味着不应使用 sessions 或 cookies，因此每个请求应附带某种授权凭证，因为用户授权状态可能没通过 sessions 或 cookies 维护，常用的做法是每个请求都发送一个秘密的 access token 来认证用户，由于 access token 可以唯一识别和认证用户，API 请求应通过 HTTPS 来防止man-in-the-middle (MitM) 中间人攻击.
Yii 2.0 RESTful API 认证教程
 Yii Framework 2.0 权威指南-认证

补充说明
postman post访问获取登录接口获取access_token

接口:
http://yiiapi.com/users/login
返回:
{
    "access_token": "k3WipHWtz3rp_7-2_pYGJpoquf75XXhM"
}

如下图:

登录获取access_token
URL携带access_token授权访问

接口:
http://yiiapi.com/books/1?access-token=praaIaJ0O21aBh9w2LjFmpYb33iLCXg8
如下图:

在这里插入图片描述
apache环境下解决restful认证无法从header中获取Authorization参数
请求时在请这里是列表文本求头上带上Authorization参数：

    Authorization:Bearer your_token

但是在认证类中取不到该参数。解决方法：在.htaccess文件中加入

SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1

传递 header头信息

hear

kenven+

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录