Download the PHP package webpractik/bitrixoa without Composer
On this page you can find all versions of the php package webpractik/bitrixoa. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download webpractik/bitrixoa
More information about webpractik/bitrixoa
Files in webpractik/bitrixoa
Download webpractik/bitrixoa
More information about webpractik/bitrixoa
Files in webpractik/bitrixoa
Vendor webpractik
Package bitrixoa
Short Description A package for generating annotations and drawing SwUi when working with Bitrix controllers.
License MIT
Homepage https://github.com/webpractik/bitrixoa
Package bitrixoa
Short Description A package for generating annotations and drawing SwUi when working with Bitrix controllers.
License MIT
Homepage https://github.com/webpractik/bitrixoa
Please rate this library. Is it a good library?
Informations about the package bitrixoa
[bitrixoa] Bitrix OpenApi
Пакет для генерации Swagger UI на основе аннотаций при работе с контроллерами и роутером Bitrix.
Установка
Генерация
Параметры
--bitrix-generate
параметр указывает, что openapi необходимо смотреть в директорию local/modules--index-mode
создаст сгенерированный /api-doc/index.php с разметкой swaggerui физически.
Режимы работы
A. Через нативный bitrix router (v20+)
Если Ваш роутер не настроен, то прочтите Настройка роутера Bitrix:
-
Добавьте в роутер
- В таком случае документация откроется по адресу
/api-doc
B. Через Bitrix Controller без роутера
- Создайте в своем модуле файл
.settings.php
- Задайте корректный namespace и конфигурации для своего модуля
- Скопируйте содержимое класса BitrixUiNativeController из этого пакета к себе в модуль, в свой класс-контроллер
- Обращайтесь по адресу
<адрес сайта>/bitrix/services/main/ajax.php?action=<ваши настройки>
С. Статический UI
Запустить генерацию с флагом --index-mode
создаст сгенерированный /api-doc/index.php
с разметкой swaggerui физически.
Roadmap
- [ ] Сделать генерацию путей на основе анализа роутера
- [ ] Покрыть тестами
All versions of bitrixoa with dependencies
PHP Build Version
Package Version
Requires
zircote/swagger-php Version
^3.1 || ^4.6.1
The package webpractik/bitrixoa contains the following files
Loading the files please wait ....