PHPackages                             oxid-community/oxid-rest-api - 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. [Framework](/categories/framework)
4. /
5. oxid-community/oxid-rest-api

ActiveProject[Framework](/categories/framework)

oxid-community/oxid-rest-api
============================

REST API for OXID eShop based on Laravel Lumen Framework.

v1.3.1(7y ago)4948[1 PRs](https://github.com/OXIDprojects/oxid-rest-api/pulls)MITPHPPHP >=7.1.3

Since Nov 10Pushed 6y ago9 watchersCompare

[ Source](https://github.com/OXIDprojects/oxid-rest-api)[ Packagist](https://packagist.org/packages/oxid-community/oxid-rest-api)[ RSS](/packages/oxid-community-oxid-rest-api/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (5)Dependencies (5)Versions (7)Used By (0)

Overview
========

[](#overview)

{% hint style="info" %} **Documentation:**
**Repository:** {% endhint %}

About
-----

[](#about)

This community project was started on the [OXID Hackathon 2018](https://openspacer.org/12-oxid-community/223-oxid-hackathon-nuernberg-2018/).
It´s based on the PHP micro framework [Lumen](https://lumen.laravel.com/).

Status quo
----------

[](#status-quo)

This project is wip (work in progress). The API is functionally working and the first route [*articles*](routes-1/routes/articles.md#get-all-articles) exists.

{% page-ref page="contribution.md" %}

{% page-ref page="changelog.md" %}

SwaggerLume Installation
------------------------

[](#swaggerlume-installation)

- Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)
- Make configuration changes if needed
- Run `php artisan swagger-lume:publish` to publish everything

Configuration
-------------

[](#configuration)

- Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)
- Run `php artisan swagger-lume:publish-views` to publish views (`resources/views/vendor/swagger-lume`)
- Run `php artisan swagger-lume:publish` to publish everything
- Run `php artisan swagger-lume:generate` to generate docs

Credits
-------

[](#credits)

- Tobias Merkl | [@tabsl](https://twitter.com/tabsl) | [proudcommerce.com](https://www.proudcommerce.com)
- Stefan Moises | [@upsettweety](https://twitter.com/upsettweety) | [rent-a-hero.de](http://www.rent-a-hero.de)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 74.2% 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.

###  Release Activity

Cadence

Every ~4 days

Total

5

Last Release

2721d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a72de4de9079aff55fc72c9d92906c146299cc7d5ed4764ce8d855e2edba041f?d=identicon)[oxid-community](/maintainers/oxid-community)

---

Top Contributors

[![tabsl](https://avatars.githubusercontent.com/u/1520658?v=4)](https://github.com/tabsl "tabsl (69 commits)")[![smxsm](https://avatars.githubusercontent.com/u/1737182?v=4)](https://github.com/smxsm "smxsm (19 commits)")[![jkrug](https://avatars.githubusercontent.com/u/971308?v=4)](https://github.com/jkrug "jkrug (2 commits)")[![proudcommerce](https://avatars.githubusercontent.com/u/4111533?v=4)](https://github.com/proudcommerce "proudcommerce (2 commits)")[![Jenya222](https://avatars.githubusercontent.com/u/19821303?v=4)](https://github.com/Jenya222 "Jenya222 (1 commits)")

---

Tags

apiframeworklaravelrestlumenOXID

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/oxid-community-oxid-rest-api/health.svg)

```
[![Health](https://phpackages.com/badges/oxid-community-oxid-rest-api/health.svg)](https://phpackages.com/packages/oxid-community-oxid-rest-api)
```

PHPackages © 2026

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