Download the PHP package webpractik/api without Composer
On this page you can find all versions of the php package webpractik/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download webpractik/api
More information about webpractik/api
Files in webpractik/api
Download webpractik/api
More information about webpractik/api
Files in webpractik/api
Please rate this library. Is it a good library?
Informations about the package api
webpractik/api
Простой интерфейс для написания api в CMS Bitrix.
Выносит все обработчики в пространство /api/, заставляя разработчиков писать унифицированные обработчики.
Решение для тех кому надоело писать компоненты-обработчики, плодить кучу файлов в doc_root аля в папке /ajax и кто не внедрил себе роутер из laravel/symphony.
⚠️ Deprecated
Рекомендуется использовать
- Нативные контроллерые Bitrix
- Контроллеры Laravel/Symphony
Данный модуль для старых проектов или для обратной совместимости.
Установка в CMS Bitrix
- Установка модуля в админке
Процесс установки
В процессе установки модуль
- Добавляет в корень DocRoot
api-router.php - Устанавливает маршрут
/api/вurlrewrite.php - Устанавливает компонент в
local/components/webpractik/api/
Написание обработчиков
- Регистрируем маршруты
$arUrlTemplatesв компоненте webpractik:api в local.
В модули передаем те которые нужны для autoload (@todo fixme)
- Добавляем обработчик \MySite\Lk\Response\Resubmit наследуя его от \Webpractik\Api\Response
| Method | Description |
|---|---|
| public function handler(){} | главная логика |
| public function validate() | логика проверок. При |
| public $method | GET/POST - ожидаемый тип запроса |
| public $request | \Bitrix\Main\HttpRequest https://dev.1c-bitrix.ru/api_d7/bitrix/main/request/index.php |
| public $response | \Webpractik\Api\JsonResponse |
Json example
Интерфейс JsonResponse
| Method | Description | |
|---|---|---|
| addError($strError) | добавление ошибки | |
| addParam($name, $value) | добавление параметра в json | |
| setSuccess/setFail | установка status true/false | |
| send | json_encode + die() | |
| sendSuccess | setSuccess + send() | |
| sendFail($strError) | addError($strError) + send() | |
| haveErrors() | true | false |
| getErrors() | array | |
| getResponse() | array |
Example
пример абстрактный, просто чтобы показать возможности
All versions of api with dependencies
PHP Build Version
Package Version
Requires
composer/installers Version
>=1.0.22 <2.0
The package webpractik/api contains the following files
Loading the files please wait ...