Introduction au contrôle de version de l'API RESTful Yii2.0 (exemple de code)

Le contenu de cet article est une introduction au contrôle de version de l'API RESTful Yii2.0 (exemples de code). Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer.

J'ai déjà écrit deux articles sur la façon de créer l'API RESTful Yii2.0, ainsi que sur l'authentification et d'autres traitements, mais ils n'impliquaient pas la gestion des versions. Aujourd'hui, je vais parler de la façon d'implémenter la gestion des versions.

Partez de zéro et construisez-le étape par étape. Cependant, certains concepts et utilisations ne seront pas expliqués un par un dans cet article. Vous pouvez vous référer au premier tutoriel de configuration de base de l'API RESTful Yii2.0 pour la configuration.

Installer Yii2.0

Installer via Composer

C'est la méthode préférée pour installer Yii2.0. Si Composer n’est pas encore installé, vous pouvez suivre les instructions ici pour l’installer.

Après avoir installé Composer, exécutez la commande suivante pour installer le plug-in Composer Asset :

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

Pour installer le modèle d'application avancé, exécutez la commande suivante :

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

Copiez le répertoire backend et nommez-le api

Ouvrez apiconfigmain.php et modifiez l'identifiant, controllerNamespace :

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

Initialisez le modèle avancé

Avant d'initialiser, vous souhaiterez peut-être lire cet article

cd advanced
php init

Ouvrez commonconfigmain.php et activez les règles d'embellissement du routage d'URL

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

Ouvrez commonconfigbootstrap. php et ajoutez les alias suivants

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

ok, le travail ci-dessus est prêt, allons droit au but
Pour plus d'informations sur la version, vous pouvez vous référer au guide faisant autorité. Je n'explique pas trop ici (PS : Surtout, je ne sais pas comment...)

Ma compréhension :
Vous pouvez comprendre les versions de Yii2 comme des modules différents. Chaque version est un nouveau module. , comme les v1, v2, etc.

Construction de modules

Quant à la façon de générer des modules, nous pouvons utiliser GII pour les générer.

Configurer GII

Ouvrez le fichier api/config/main-local.php et modifiez-le comme suit :

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

Comme j'utilise Homestead, l'accès à GII n'est pas autorisé par défaut, j'ai donc pour ajouter 'allowedIPs' => ['127.0.0.1', '*'] , sinon Forbidden (#403) apparaîtra. Vous pouvez le configurer selon vos propres besoins, ou ne pas configurer

pour. générer des modules

Entrez http://votre hôte/gii dans le navigateur, vous pouvez voir le générateur de modules, cliquez sur Démarrer

Classe de modules et saisissez : apimodulesv1Module

ID du module entrez v1, (généralement, il entrera automatiquement)

Cliquez sur Aperçu

Enfin, cliquez sur Générer pour générer

Module de configuration

Ouvrez le fichier api/config/main.php, modifiez les modules

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

Puis modifiez urlManager

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

Sur la base de ce qui précède, l'API RESTFul Yii2.0 implémente la gestion des versions, on peut y accéder via l'adresse suivante :

http://localhost/v1/defaults

Pour en dire un peu plus, l'adresse au dessus de moi a a été mappé au répertoire api/web, veuillez suivre le vôtre. Configurez la situation réelle

Ouvrez le répertoire de fichiers des modules que vous venez de générer. Vous pouvez voir qu'il contient un répertoire v1. a également un répertoire de contrôleurs et de vues
, que nous venons de visiter par défaut, ce sont en fait ces deux fichiers, tout comme les projets Web traditionnels, le contrôleur restitue la vue

D'accord, vous savez peut-être que notre futur contrôleur. le code sera placé dans modules/v1/controllers

Pour l'instant, c'est juste le code généré par le GII par défaut pour nous. Parce que nous sommes une API, nous n'utilisons généralement pas le répertoire vues.

Créer un contrôleur de repos
Créer un nouveau UserController sous modulesv1controllers

<?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;;
    }
}

Modifier l'urlManager dans 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',
            ],
        ],
    ],
],

Essayer de visiter

http://localhost/v1/users/index

ok, ce qui précède est la méthode d'implémentation de la gestion des versions Yii2.0

Formater la réponse

Modifier api/config/main. php Ajouter une réponse

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

dans le tableau des composants

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!