Den2016 / yii2-rest-app

Yii 2.0 Advanced Application Template

Шаблон проекта RESTful API на Yii2

Этот шаблон RESTful API на Yii 2, основанный на шаблоне приложения advanced.

В шаблоне frontend оставлен практически без изменений, переделке подверглась backend часть, которая теперь заточена под rest api. Аутентификация пользователей делается с помощью JSON Web Token.

---

Требования

Системные требования те же, что и для basic или advanced приложения на Yii2

---

Установка

git clone https://github.com/Den2016/yii2-rest-app.git
cd yii2-rest-app
composer install
init или php init

далее настраиваем соединение с базой данных в /common/config/main-local.php далее

./yii migrate 1
./yii migrate --migrationPath=@yii/rbac/migrations
./yii migrate 

TODO много чего

пример файла .htaccess для OpenServer

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . index.php [L]

Создаем простейшую точку входа. Для этого в api/config/main.php в components->urlManager->rules добавляем еще один массив, то есть urlManager будет выглядеть так

        'urlManager' => [
            'enablePrettyUrl' => true,
            'enableStrictParsing' => true,
            'showScriptName' => false,
            'rules' => [
                [
                    'class' => UrlRule::class,
                    'controller' => 'user',
                    'pluralize' => true,
                ],
                [
                    'class' => UrlRule::class,
                    'controller' => 'login',
                    'extraPatterns' => [
                        'POST signup' => 'signup',
                        'POST login' => 'login',
                        'GET logout' => 'logout',
                    ],
                    'pluralize' => false,
                ],
                //добавленный массив
                [
                    'class' => UrlRule::class,
                    'controller' => 'api',
                    'pluralize' => false,
                ],
            ],
        ],

далее в api/controllers создаем контроллер ApiController

<?php


namespace api\controllers;


use yii\rest\Controller;

class ApiController extends Controller
{
    public function actionIndex(){
        return [1,2,3,'test'];
    }
}

в результате при обращении к /api методом GET мы должны получить следующий JSON

{
    "success": true,
    "data": [
        1,
        2,
        3,
        "test"
    ],
    "statusCode": 200,
    "statusText": "OK"
}

форматирование ответа производится в api/config/main.php в обработчике on beforeSend