Introduction to version control of Yii2.0 RESTful API (code example)

This article brings you an introduction to the version control of Yii2.0 RESTful API (code examples). It has certain reference value. Friends in need can refer to it. I hope it will be helpful to you.

I have written two articles before about how to build Yii2.0 RESTful API, as well as authentication and other processing, but they did not involve version management. Today I will talk about how to implement version management.

Let’s just start from scratch and build it step by step. However, some concepts and usage will not be explained one by one in this article. You can refer to the first Yii2.0 RESTful API basic configuration tutorial for configuration

Install Yii2.0

Install via Composer

This is the preferred method to install Yii2.0. If you don't have Composer installed yet, you can follow the instructions here to install it.

After installing Composer, run the following command to install the Composer Asset plug-in:

composer global require "fxp/composer-asset-plugin:^1.2.0"

To install the advanced application template, run the following command:

composer create-project yiisoft/yii2-app-advanced yii-api 2.0.14

Copy backend directory, named api

Open api\config\main.php and modify the id, controllerNamespace:

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

Initialize the advanced template

Before initializing, you may wish to read this article

cd advanced
php init

Open common\config\main.php to enable url routing beautification rules

'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName' => false,
    'rules' => [
    ],
],

Open common\config\bootstrap.php and add the following alias

Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');

ok, the above work is ready, let’s get to the point,
For more information about the version, you can refer to the authoritative guide, but I won’t explain too much here (PS: Mainly, I don’t know how to...)

My understanding:
You can understand the versions of Yii2 as different modules. Each version is a new module, such as the common v1, v2, etc.

Building the module

Regarding how to generate the module, we can use GII to generate it.

Configuring GII

Open the api/config/main-local.php file and modify it as follows:

if (!YII_ENV_TEST) {
    // configuration adjustments for 'dev' environment
    $config['bootstrap'][] = 'debug';
    $config['modules']['debug'] = [
        'class' => 'yii\debug\Module',
    ];

    $config['bootstrap'][] = 'gii';
    $config['modules']['gii'] = [
        'class' => 'yii\gii\Module',
        'allowedIPs' => ['127.0.0.1', '*']
    ];
}

Because I am using Homestead, access to GII is not allowed by default, so I have to add 'allowedIPs' => ; ['127.0.0.1', '*'], otherwise Forbidden (#403) will appear. You can configure it according to your own needs, or do not configure it

Generate Modules

Browse Enter http://your host/gii into the generator, you can see the Module Generator, click Start

Modules Class and enter: api\modules\v1\Module

Module ID and enter v1, (Generally it will be entered automatically)

Click Preview

##Finally click Generate to generate

Configuration module

Open the api/config/main.php file, modify modules

'modules' => [
    'v1'=>[
        'class'=>'api\modules\v1\Module',
    ],
],

Then modify urlManager

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule',
            'controller' => 'v1/default',
            'extraPatterns'=>[
                'GET index'=>'index',
            ],
        ],
    ],
],

Based on the above , Yii2.0 RESTFul API implements version management, we can access it through the following address:

http://localhost/v1/defaults

To say a little more, the address above me has been mapped to the api/web directory, please base it on your actual situation Configure

Open the modules file directory just generated. You can see that there is a v1 directory in it. You can see that the directory also has a controllers and a views directory

. In fact, the defaults we just visited These two files are the same as traditional web projects. The controller renders the view

Okay, you may know that our future controller code will be placed in modules/v1/controllers

Just now is just the code generated by the default GII for us. Because we are an API, we generally don't use the views directory.

Create a rest controller

Create a new UserController under modules\v1\controllers

<?php namespace api\modules\v1\controllers;

use yii\rest\Controller;

/**
 * User controller for the `v1` module
 */
class UserController extends Controller
{
    /**
     * @return string
     */
    public function actionIndex()
    {
        return &#39;this is v1/user&#39;;
    }
}

Modify the urlManager in api/config/main.php

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule',
            'controller' => 'v1/default',
            'extraPatterns'=>[
                'GET index'=>'index',
            ],
        ],
        ['class' => 'yii\rest\UrlRule',
            'controller' => 'v1/user',
            'extraPatterns'=>[
                'GET index'=>'index',
            ],
        ],
    ],
],

Try Next visit

http://localhost/v1/users/index

ok, the above is the implementation method of Yii2.0 version management

Formatted response

Modify api/config/main. php add response

'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;
    },
],

in the components array

The above is the detailed content of Introduction to version control of Yii2.0 RESTful API (code example). For more information, please follow other related articles on the PHP Chinese website!