{"id":21361711,"url":"https://github.com/webpractik/bitrixoa","last_synced_at":"2025-07-13T02:32:22.971Z","repository":{"id":52192226,"uuid":"368448597","full_name":"webpractik/bitrixoa","owner":"webpractik","description":"Пакет для генерации аннотаций и отрисовки SwUi, при работе с контроллерами Bitrix.","archived":false,"fork":false,"pushed_at":"2023-02-09T09:02:27.000Z","size":21,"stargazers_count":35,"open_issues_count":4,"forks_count":10,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-11-02T06:28:20.295Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webpractik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-18T08:02:06.000Z","updated_at":"2024-10-19T19:16:47.000Z","dependencies_parsed_at":"2022-08-24T13:10:08.202Z","dependency_job_id":null,"html_url":"https://github.com/webpractik/bitrixoa","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fbitrixoa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fbitrixoa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fbitrixoa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fbitrixoa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webpractik","download_url":"https://codeload.github.com/webpractik/bitrixoa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225850218,"owners_count":17534067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T06:11:01.428Z","updated_at":"2024-11-22T06:11:01.968Z","avatar_url":"https://github.com/webpractik.png","language":"PHP","readme":"# [bitrixoa] Bitrix OpenApi\nПакет для генерации [Swagger UI](https://swagger.io/tools/swagger-ui/) на основе аннотаций при работе с [контроллерами](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43\u0026LESSON_ID=6436\u0026LESSON_PATH=3913.3516.5062.3750.6436) и роутером Bitrix.\n\n## Установка\n```angular2html\ncomposer install webpractik/bitrixoa\n```\n\n## Генерация\n```./vendor/bin/bitrixoa```\n\n### Параметры\n1. `--bitrix-generate` параметр указывает, что openapi необходимо смотреть в директорию local/modules\n2. `--index-mode` создаст сгенерированный /api-doc/index.php с разметкой swaggerui физически.\n\n## Режимы работы\n### A. Через нативный bitrix router (v20+)\n\nЕсли Ваш роутер не настроен, то прочтите [Настройка роутера Bitrix](docs/bxrouter.md):\n1. Добавьте в роутер\n```php\nuse Bitrix\\Main\\Routing\\RoutingConfigurator;\n\nreturn function (RoutingConfigurator $configurator) {\n        $configurator-\u003eget('api-doc', [\\BitrixOA\\BitrixUiController::class, 'apidocAction']);\n};\n```\n2. В таком случае документация откроется по адресу `/api-doc`\n\n### B. Через Bitrix Controller без роутера\n1. Создайте в своем модуле файл `.settings.php`\n2. Задайте корректный namespace и конфигурации для своего модуля\n3. Скопируйте содержимое класса BitrixUiNativeController из этого пакета к себе в модуль, в свой класс-контроллер\n4. Обращайтесь по адресу `\u003cадрес сайта\u003e/bitrix/services/main/ajax.php?action=\u003cваши настройки\u003e` \n\n### С. Статический UI\nЗапустить генерацию с флагом `--index-mode` создаст сгенерированный `/api-doc/index.php` с разметкой swaggerui физически.\n\n## Roadmap\n- [ ] Сделать генерацию путей на основе анализа роутера\n- [ ] Покрыть тестами\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpractik%2Fbitrixoa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebpractik%2Fbitrixoa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpractik%2Fbitrixoa/lists"}