README

Bitrix CMS中编写API的简单界面。

将所有处理程序放置在/api/空间，使开发者能够编写统一的处理程序。

为那些厌倦了编写组件处理程序、在doc_root中产生大量文件（如/ajax文件夹）以及尚未实施laravel/symphony路由器的人提供的解决方案。

⚠️ 已弃用

建议使用

• Bitrix原生控制器
• Laravel/Symphony控制器

本模块适用于旧项目或向后兼容。

在Bitrix CMS中安装

1. composer require webpractik/api
2. 在管理员面板中安装模块

安装过程

在安装过程中

• 在DocRoot根目录添加api-router.php
• 在urlrewrite.php中安装/api/路由
• 在local/components/webpractik/api/中安装组件

编写处理程序

1. 在本地webpractik:api组件中注册$arUrlTemplates路由

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

在模块中传递需要自动加载的模块（@todo fixme）

1. 添加处理程序 \MySite\Lk\Response\Resubmit，它继承自 \Webpractik\Api\Response

JSON示例

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

JsonResponse接口

示例

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();
	}
}

这是一个抽象示例，仅为了展示功能。