PHPackages                             kiri4tanker/k4t.docs - 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. kiri4tanker/k4t.docs

ActiveBitrix-d7-module[API Development](/categories/api)

kiri4tanker/k4t.docs
====================

Автоматическая документация Bitrix на Swagger

v1.2.0(1mo ago)15MITPHPPHP >=8.2CI passing

Since Apr 1Pushed 1mo agoCompare

[ Source](https://github.com/kiri4tanker/bitrix-swagger-docs)[ Packagist](https://packagist.org/packages/kiri4tanker/k4t.docs)[ RSS](/packages/kiri4tanker-k4tdocs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (4)Used By (0)

k4t.docs
========

[](#k4tdocs)

[![Packagist](https://camo.githubusercontent.com/bc4291266c80ac180aedbd5d49cb016b8fab7bbbaf407c9f243f8a72e107ecd0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b6972693474616e6b65722f6b34742e646f63733f6c6f676f3d7061636b6167697374266c6162656c3d5061636b6167697374)](https://packagist.org/packages/kiri4tanker/k4t.docs)[![CI](https://github.com/kiri4tanker/bitrix-swagger-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/kiri4tanker/bitrix-swagger-docs/actions/workflows/ci.yml)[![License](https://camo.githubusercontent.com/1802139e150674d4d1602e53ee5fb587197addabe41e217215582a449c357fdf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6b6972693474616e6b65722f6b34742e646f6373)](https://packagist.org/packages/kiri4tanker/k4t.docs)[![Security Policy](https://camo.githubusercontent.com/0330abd3b567f251709d74b4e8db5196f5c7fc5a967dd092c1ab7ce1b2be25df/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73656375726974792d706f6c6963792d627269676874677265656e)](SECURITY.md)

English version: [README.en.md](README.en.md)

Модуль Composer для Bitrix D7, который собирает OpenAPI-спецификацию (`swagger-php`) из ваших модулей и отдает:

- интерактивную документацию (`Scalar UI`)
- JSON-спецификацию (`docs.json`)

Пакет на Packagist: [kiri4tanker/k4t.docs](https://packagist.org/packages/kiri4tanker/k4t.docs)

Процессы проекта:

- [SECURITY.md](SECURITY.md)
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CHANGELOG.md](CHANGELOG.md)

Что умеет модуль
----------------

[](#что-умеет-модуль)

- Сканирует указанные папки во всех или выбранных модулях Bitrix.
- Генерирует OpenAPI через `zircote/swagger-php`.
- Позволяет задать список `servers` или использовать автоопределение хоста.
- Поддерживает включение/отключение документации (`enabled`).
- Поддерживает whitelist групп (`allowed_groups`).
- Поддерживает whitelist IP/CIDR (`allowed_ips`).
- Использует локальный (self-hosted) Scalar bundle из модуля, без внешнего CDN.
- В UI грузит спецификацию по URL (`docs.json`), без inline JSON в HTML.
- Кэширует результат генерации в Managed Cache Bitrix.
- Возвращает понятные ошибки конфигурации/генерации.

Требования
----------

[](#требования)

- PHP `>= 8.2`
- Bitrix D7
- Composer
- `zircote/swagger-php` (подтягивается автоматически)

Быстрый старт
-------------

[](#быстрый-старт)

1. Добавьте в `composer.json` проекта installer path для модулей Bitrix:

```
{
	"extra": {
		"installer-paths": {
			"local/modules/{$name}/": [
				"type:bitrix-d7-module"
			]
		}
	}
}
```

2. Установите пакет:

```
composer require kiri4tanker/k4t.docs
```

3. Установите модуль в админке Bitrix:

`Настройки -> Настройки продукта -> Модули -> k4t.docs`

4. Добавьте маршруты `docs` и `docs.json` (пример ниже).
5. Добавьте `swagger_settings` в корневой `.settings.php`.

Подключение маршрутов
---------------------

[](#подключение-маршрутов)

Пример файла `/local/routes/api.php`:

```