PHPackages                             webpractik/bitrixoa - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. webpractik/bitrixoa

ActiveLibrary[API Development](/categories/api)

webpractik/bitrixoa
===================

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

v1.2.0(3y ago)408.5k↓41.7%10[4 issues](https://github.com/webpractik/bitrixoa/issues)MITPHP

Since May 18Pushed 3y ago8 watchersCompare

[ Source](https://github.com/webpractik/bitrixoa)[ Packagist](https://packagist.org/packages/webpractik/bitrixoa)[ Docs](https://github.com/webpractik/bitrixoa)[ RSS](/packages/webpractik-bitrixoa/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (7)Dependencies (1)Versions (8)Used By (0)

\[bitrixoa\] Bitrix OpenApi
===========================

[](#bitrixoa-bitrix-openapi)

Пакет для генерации [Swagger UI](https://swagger.io/tools/swagger-ui/) на основе аннотаций при работе с [контроллерами](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43&LESSON_ID=6436&LESSON_PATH=3913.3516.5062.3750.6436) и роутером 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+)

[](#a-через-нативный-bitrix-router-v20)

Если Ваш роутер не настроен, то прочтите [Настройка роутера Bitrix](docs/bxrouter.md):

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

```
use Bitrix\Main\Routing\RoutingConfigurator;

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

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

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

[](#b-через-bitrix-controller-без-роутера)

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

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

[](#с-статический-ui)

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

Roadmap
-------

[](#roadmap)

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

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity36

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~105 days

Recently: every ~158 days

Total

7

Last Release

1194d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c141e494b1e0e011a6ff59fce1807616886ee906e9fbdb581811920e0bde5e8c?d=identicon)[webpractik](/maintainers/webpractik)

---

Top Contributors

[![north-leshiy](https://avatars.githubusercontent.com/u/5521833?v=4)](https://github.com/north-leshiy "north-leshiy (2 commits)")[![shk-webpr](https://avatars.githubusercontent.com/u/74294262?v=4)](https://github.com/shk-webpr "shk-webpr (2 commits)")[![mnlght](https://avatars.githubusercontent.com/u/34452808?v=4)](https://github.com/mnlght "mnlght (1 commits)")

---

Tags

swaggerbitrixbitrix controllers

### Embed Badge

![Health badge](/badges/webpractik-bitrixoa/health.svg)

```
[![Health](https://phpackages.com/badges/webpractik-bitrixoa/health.svg)](https://phpackages.com/packages/webpractik-bitrixoa)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[jlapp/swaggervel

A great way to integrate Swagger into Laravel

492931.6k2](/packages/jlapp-swaggervel)[light/yii2-swagger

swagger intergation with yii2

154801.6k4](/packages/light-yii2-swagger)[tangwei/apidocs

A swagger library for Hyperf.

51130.4k8](/packages/tangwei-apidocs)[latrell/swagger

Swagger for Laravel 5

4962.8k](/packages/latrell-swagger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)