REST Framework

1.0.0 (06.02.2020)	Первый общедоступный релиз v1.0.0
0.3.4 (04.02.2020)	Мелкие исправления
0.3.3 (03.02.2020)	Исправлены настройки соединения с БД Добавлено описание модуля
0.3.2 (31.01.2020)	Создание заказа в одно действие Логирование ошибок в Журнал событий

Установите решение из каталога.
Системные требования: PHP >= 7.0
Расширения PHP: curl, mbstring, json, pdo, mysql

В текущей версии решению для работы нужен стандартный интернет-магазин Битрикс

После установки нужно включить API в настройках модуля

Описание работы с модулем: https://xzag.ru/bitrix/xzag.rest/v1/index.html


Расширение REST Framework

Фреймворк поддерживает самостоятельное расширение функциональности разработчиками.

Создание собственного контроллера

Пример. Создадим в папке local/php_interface/xzag.rest/controllers файл SampleController.php со следующим содержимым
<?php

namespace xzag\rest\app\controllers;

use yii\web\Controller;

class SampleController extends Controller
{
   public function actionTest()
   {
       return ['success' => true, 'year' => date('Y')];
   }
}


Сделав запрос GET /xzag.rest/sample/test, ожидаем получить в ответ что-то подобное
{
   "success": true,
   "year": "2020"
}
Подобным образом можно неограниченно расширять функциональность REST Framework

Ограничение доступа

Чтобы разрешить доступ к контроллеру или методу только авторизованным пользователям, рекомендуется воспользоваться существующим трейтом xzag\rest\app\modules\v1\traits\AuthorizedUser и подключить его в нужном контроллере, по необходимости дополняя его поведение

Расширение конфигурации

Вы можете дополнить конфигурацию фреймворка Yii 2 с помощью конфигурационного файла local/php_interface/xzag.rest/config/web.php

Подробнее о настройках фреймворка читайте в документации к Yii 2.

Дополнительную информацию о работе модуля можно получить в техподдержке

Вопросы по работе модуля можно писать на электронную почту support@xzag.ru