PHPackages                             odyssey/simple-rest-adapter-bundle - 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. odyssey/simple-rest-adapter-bundle

ActivePimcore-bundle[API Development](/categories/api)

odyssey/simple-rest-adapter-bundle
==================================

Simple REST Adapter for Pimcore DataHub (fork compatible with Pimcore 11)

010PHP

Since Mar 18Pushed 3mo agoCompare

[ Source](https://github.com/remzone/OdysseySimpleRESTAdapterBundle)[ Packagist](https://packagist.org/packages/odyssey/simple-rest-adapter-bundle)[ RSS](/packages/odyssey-simple-rest-adapter-bundle/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Odyssey Simple REST Adapter Bundle
==================================

[](#odyssey-simple-rest-adapter-bundle)

Read this in: [English](#english) | [Русский](#russian)

English
-------

[](#english)

`odyssey/simple-rest-adapter-bundle` is a public Pimcore bundle that adds a configurable read-only REST API on top of Pimcore DataHub.

The bundle is designed for projects that need a lightweight integration layer for external services, storefronts, frontends, mobile applications, or middleware. Exposed data is indexed in Elasticsearch and served from there, which reduces direct database load and keeps API responses predictable for high-read scenarios.

### Highlights

[](#highlights)

- Compatible with `Pimcore 11`
- Built as a standalone reusable bundle for installation in other Pimcore projects
- Read-only REST endpoints for `DataObjects` and `Assets`
- DataHub-based schema configuration
- switchable `OpenSearch / Elasticsearch` backend configuration
- Filtering, full-text search, sorting, pagination, and aggregations
- Swagger UI for endpoint discovery and testing
- Bearer-token protected API access

### Requirements

[](#requirements)

- PHP `>= 8.1`
- Pimcore `^11.0`
- Pimcore DataHub
- Elasticsearch
- Symfony Messenger

### Installation

[](#installation)

Install the bundle via Composer:

```
composer require odyssey/simple-rest-adapter-bundle
```

If your project does not auto-register Pimcore bundles, register:

```
CIHub\Bundle\SimpleRESTAdapterBundle\SimpleRESTAdapterBundle::class => ['all' => true],
```

### What You Get

[](#what-you-get)

The bundle exposes a configurable REST layer with the following typical capabilities:

- `tree-items`: browse a tree level with pagination, filtering, sorting, search, and aggregations
- `search`: query indexed elements across configured data
- `get-element`: fetch a single element by type and ID
- Swagger documentation endpoint for inspection and manual testing

### Typical Use Cases

[](#typical-use-cases)

- Headless storefront integrations
- Frontend applications consuming Pimcore content
- Lightweight external system synchronization
- Search-oriented APIs backed by indexed Pimcore data

### Fork Differences

[](#fork-differences)

Compared to the original CI HUB version, this Odyssey-maintained fork includes:

- compatibility updates for `Pimcore 11`
- maintained Swagger support for `Pimcore 11` and `Pimcore 12` environments
- configurable switching between `OpenSearch` and `Elasticsearch`
- ongoing compatibility maintenance for modern Pimcore projects
- an open `GPL-3.0-or-later` license that allows further customization and community-driven improvements

### Documentation

[](#documentation)

- [Installation and configuration (EN)](docs/en/00-installation-configuration.md)
- [Endpoint configuration (EN)](docs/en/01-endpoint-configuration.md)
- [Indexing details (EN)](docs/en/02-indexing.md)
- [Docker setup example (EN)](docs/en/03-docker-setup-example.md)
- [Установка и конфигурация (RU)](docs/ru/00-installation-configuration.md)
- [Настройка endpoint'ов (RU)](docs/ru/01-endpoint-configuration.md)
- [Индексирование (RU)](docs/ru/02-indexing.md)
- [Пример Docker setup (RU)](docs/ru/03-docker-setup-example.md)

### Screenshots

[](#screenshots)

[![Schema Configuration](docs/images/schema.png "Schema Configuration")](docs/images/schema.png)[![Swagger UI](docs/images/swagger_ui.png "Swagger UI")](docs/images/swagger_ui.png)

### Package Notes

[](#package-notes)

- Package name: `odyssey/simple-rest-adapter-bundle`
- Namespace: `CIHub\Bundle\SimpleRESTAdapterBundle`
- This repository contains the public Odyssey-maintained fork adapted for modern Pimcore usage
- The original bundle codebase was created by CI HUB
- Ongoing compatibility updates and fork maintenance are provided by Odyssey

### License

[](#license)

Licensed under `GPL-3.0-or-later`. See [LICENSE.md](LICENSE.md).

Русский
-------

[](#русский)

`odyssey/simple-rest-adapter-bundle` это публичный Pimcore bundle, который добавляет настраиваемый read-only REST API поверх Pimcore DataHub.

Bundle подходит для проектов, где нужен лёгкий интеграционный слой для внешних сервисов, витрин, frontend-приложений, мобильных клиентов или middleware. Данные индексируются в Elasticsearch и отдаются оттуда, что снижает нагрузку на базу данных и делает ответы API стабильнее в сценариях с большим числом запросов на чтение.

### Основные возможности

[](#основные-возможности)

- Совместимость с `Pimcore 11`
- Самостоятельный переиспользуемый bundle для установки в другие Pimcore-проекты
- Read-only REST endpoints для `DataObjects` и `Assets`
- Конфигурирование схемы через DataHub
- переключаемый backend `OpenSearch / Elasticsearch`
- Фильтрация, полнотекстовый поиск, сортировка, пагинация и агрегации
- Swagger UI для просмотра и тестирования endpoint'ов
- Защита API через bearer token

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

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

- PHP `>= 8.1`
- Pimcore `^11.0`
- Pimcore DataHub
- Elasticsearch
- Symfony Messenger

### Установка

[](#установка)

Установите bundle через Composer:

```
composer require odyssey/simple-rest-adapter-bundle
```

Если в проекте bundle не регистрируются автоматически, добавьте:

```
CIHub\Bundle\SimpleRESTAdapterBundle\SimpleRESTAdapterBundle::class => ['all' => true],
```

### Что входит

[](#что-входит)

Bundle предоставляет настраиваемый REST-слой со следующими типовыми возможностями:

- `tree-items`: загрузка элементов уровня дерева с пагинацией, фильтрацией, сортировкой, поиском и агрегациями
- `search`: поиск по индексированным элементам в настроенной схеме
- `get-element`: получение одного элемента по типу и ID
- Swagger endpoint для просмотра документации и ручной проверки API

### Типовые сценарии использования

[](#типовые-сценарии-использования)

- Интеграция headless storefront
- Frontend-приложения, работающие с данными Pimcore
- Лёгкая синхронизация с внешними системами
- Поисковые API поверх индексированных данных Pimcore

### Отличия форка

[](#отличия-форка)

По сравнению с исходной версией CI HUB, этот fork от Odyssey включает:

- обновления совместимости для `Pimcore 11`
- поддержку Swagger для окружений на `Pimcore 11` и `Pimcore 12`
- конфигурируемое переключение между `OpenSearch` и `Elasticsearch`
- дальнейшее сопровождение совместимости для современных Pimcore-проектов
- открытую лицензию `GPL-3.0-or-later`, позволяющую доработки, адаптацию и развитие сообществом

### Документация

[](#документация)

- [Installation and configuration (EN)](docs/en/00-installation-configuration.md)
- [Endpoint configuration (EN)](docs/en/01-endpoint-configuration.md)
- [Indexing details (EN)](docs/en/02-indexing.md)
- [Docker setup example (EN)](docs/en/03-docker-setup-example.md)
- [Установка и конфигурация (RU)](docs/ru/00-installation-configuration.md)
- [Настройка endpoint'ов (RU)](docs/ru/01-endpoint-configuration.md)
- [Индексирование (RU)](docs/ru/02-indexing.md)
- [Пример Docker setup (RU)](docs/ru/03-docker-setup-example.md)

### Скриншоты

[](#скриншоты)

[![Schema Configuration](docs/images/schema.png "Schema Configuration")](docs/images/schema.png)[![Swagger UI](docs/images/swagger_ui.png "Swagger UI")](docs/images/swagger_ui.png)

### Примечания по пакету

[](#примечания-по-пакету)

- Имя пакета: `odyssey/simple-rest-adapter-bundle`
- Namespace: `CIHub\Bundle\SimpleRESTAdapterBundle`
- Этот репозиторий содержит публичный fork Odyssey, адаптированный для современного Pimcore
- Исходная кодовая база bundle изначально создана CI HUB
- Дальнейшие обновления, адаптация и сопровождение форка выполняются Odyssey

### Лицензия

[](#лицензия)

Лицензия `GPL-3.0-or-later`. Подробности в [LICENSE.md](LICENSE.md).

###  Health Score

21

—

LowBetter than 18% of packages

Maintenance55

Moderate activity, may be stable

Popularity7

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 80% of commits — single point of failure

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.

### Community

Maintainers

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

---

Top Contributors

[![remzone](https://avatars.githubusercontent.com/u/155640872?v=4)](https://github.com/remzone "remzone (24 commits)")[![AndiKeiser](https://avatars.githubusercontent.com/u/9332971?v=4)](https://github.com/AndiKeiser "AndiKeiser (4 commits)")[![Joerg-Seidler](https://avatars.githubusercontent.com/u/55386240?v=4)](https://github.com/Joerg-Seidler "Joerg-Seidler (1 commits)")[![xfynx](https://avatars.githubusercontent.com/u/3057907?v=4)](https://github.com/xfynx "xfynx (1 commits)")

### Embed Badge

![Health badge](/badges/odyssey-simple-rest-adapter-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/odyssey-simple-rest-adapter-bundle/health.svg)](https://phpackages.com/packages/odyssey-simple-rest-adapter-bundle)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)

PHPackages © 2026

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