webpractik/api

Ease create ajax response

webpractik/api

Простой интерфейс для написания api в CMS Bitrix., _(*1)

Выносит все обработчики в пространство /api/, заставляя разработчиков писать унифицированные обработчики., _(*2)

Решение для тех кому надоело писать компоненты-обработчики, плодить кучу файлов в doc_root аля в папке /ajax и кто не внедрил себе роутер из laravel/symphony., _(*3)

⚠️ Deprecated

Рекомендуется использовать

• Нативные контроллерые Bitrix
• Контроллеры Laravel/Symphony

Данный модуль для старых проектов или для обратной совместимости., _(*4)

Установка в CMS Bitrix

1. composer require webpractik/api
2. Установка модуля в админке

Процесс установки

В процессе установки модуль - Добавляет в корень DocRoot api-router.php - Устанавливает маршрут /api/ в urlrewrite.php - Устанавливает компонент в local/components/webpractik/api/, _(*5)

Написание обработчиков

1. Регистрируем маршруты $arUrlTemplates в компоненте webpractik:api в local.

class ApiRouterExtended extends \Webpractik\Api\ApiRouter
{
    public $sefVariables   = [];
    public $arUrlTemplates = [
        '\MySite\Lk\Response\Resubmit' => 'application/resubmit/',
    ];
    public $arLoadModules  = [
        'webpractik.main'
    ];
}

В модули передаем те которые нужны для autoload (@todo fixme), _(*6)

1. Добавляем обработчик \MySite\Lk\Response\Resubmit наследуя его от \Webpractik\Api\Response

Json example

{
  "status": true,
  "errors": []
}

Интерфейс JsonResponse

Example

class FormRegister extends \Webpractik\Api\Response
{
    public function handler() {
        if (!$this->register()) {
            $this->response->sendFail('Ошибка регистрации')
        }
        $this->response
            ->addParam('password', $this->password)
            ->setSuccess()
            ->send();
    }

    public function validate() {
        if (!$this->request->getPost('email')) {
            $this->response->addError('Не введен email');
        }
        if (!$this->request->getPost('login')) {
            $this->response->addError('Не введен логин');
        }

        return $this->response->haveErrors();
    }
}

пример абстрактный, просто чтобы показать возможности, _(*7)