webpractik / bitrixoa

用于在处理 Bitrix 控制器时生成注释和绘制 SwUi 的软件包。

维护者

详细信息

github.com/webpractik/bitrixoa

主页

源代码

问题

安装次数: 5,534

依赖项: 0

建议者: 0

安全性: 0

星标: 35

关注者: 9

分支: 8

开放性问题: 4

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

Requires

MIT 4207c2cbad2dc394f98f2987992cfdf74ee6c44f

  • Петр Кленкин (mnlght) <pk.woop@webpractik.ru>

swaggerbitrixbitrix controllers

This package is auto-updated.

Last update: 2024-09-09 12:32:12 UTC

README

基于注解生成 Swagger UI，用于与 Bitrix 控制器和路由器 一起工作的软件包。

安装

composer install webpractik/bitrixoa

生成

./vendor/bin/bitrixoa

参数

  1. --bitrix-generate 参数指示 openapi 需要查看 local/modules 目录
  2. --index-mode 将创建带有 swaggerui 布局的生成 /api-doc/index.php 文件。

工作模式

A. 通过 Bitrix 路由器（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 控制器（无路由器）

  1. 在您的模块中创建一个 .settings.php 文件
  2. 为您的模块设置正确的 namespace 和配置
  3. 将此包中的 BitrixUiNativeController 类的内容复制到您的模块中的控制器类中
  4. 通过地址 <网站地址>/bitrix/services/main/ajax.php?action=<您的设置> 进行访问

C. 静态 UI

使用 --index-mode 标志启动生成将创建具有 swaggerui 布局的生成 /api-doc/index.php 文件。

路线图

  • 基于路由器分析生成路径
  • 进行测试