webpractik/bitrixoa

A package for generating annotations and drawing SwUi when working with Bitrix controllers.

v1.2.0 2023-02-09 08:49 UTC

Requires

• zircote/swagger-php: ^3.1 || ^4.6.1

MIT

• Петр Кленкин (mnlght)

• swagger
• bitrix
• bitrix controllers

README

Пакет для генерации Swagger UI на основе аннотаций при работе с контроллерами и роутером Bitrix.

Установка

composer install webpractik/bitrixoa

Генерация

./vendor/bin/bitrixoa

Параметры

1. --bitrix-generate параметр указывает, что openapi необходимо смотреть в директорию local/modules
2. --index-mode создаст сгенерированный /api-doc/index.php с разметкой swaggerui физически.

Режимы работы

A. Через нативный bitrix router (v20+)

Если Ваш роутер не настроен, то прочтите Настройка роутера Bitrix:

1. Добавьте в роутер

use Bitrix\Main\Routing\RoutingConfigurator;

return function (RoutingConfigurator $configurator) {
        $configurator->get('api-doc', [\BitrixOA\BitrixUiController::class, 'apidocAction']);
};

1. В таком случае документация откроется по адресу /api-doc

B. Через Bitrix Controller без роутера

1. Создайте в своем модуле файл .settings.php
2. Задайте корректный namespace и конфигурации для своего модуля
3. Скопируйте содержимое класса BitrixUiNativeController из этого пакета к себе в модуль, в свой класс-контроллер
4. Обращайтесь по адресу <адрес сайта>/bitrix/services/main/ajax.php?action=<ваши настройки>

С. Статический UI

Запустить генерацию с флагом --index-mode создаст сгенерированный /api-doc/index.php с разметкой swaggerui физически.

Roadmap

• Сделать генерацию путей на основе анализа роутера
• Покрыть тестами