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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of webpractik/bitrixoa

Informations about the package bitrixoa

[bitrixoa] Bitrix OpenApi

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

Установка

Генерация

Параметры

  1. --bitrix-generate параметр указывает, что openapi необходимо смотреть в директорию local/modules
  2. --index-mode создаст сгенерированный /api-doc/index.php с разметкой swaggerui физически.
  3. --bootstrap (-b) подключить php-файл до сканирования (нужно для swagger-php >=5, см. ниже).

Совместимость со swagger-php 5/6

Пакет работает со swagger-php ^4.6, ^5 и ^6. Ключевые отличия:

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

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

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

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

  2. В таком случае документация откроется по адресу /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

All versions of bitrixoa with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
doctrine/annotations Version ^2.0
zircote/swagger-php Version ^6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package webpractik/bitrixoa contains the following files

Loading the files please wait ...