OXIDprojects / oxid-rest-api by oxid-community

REST API for OXID eShop based on Laravel Lumen Framework.
94
4
9
framework rest api laravel oxid lumen
Github Link
Packagist Link
Package Data
Maintainer Username: oxid-community
Package Create Date: 2018-11-09
Package Last Update: 2019-12-03
Home Page: https://docs.oxid-projects.com/oxid-rest-api/
Language: PHP
License: MIT
Last Refreshed: 2025-11-18 15:13:50
Package Statistics
Total Downloads: 94
Monthly Downloads: 0
Daily Downloads: 0
Total Stars: 4
Total Watchers: 9
Total Forks: 8
Total Open Issues: 2

Overview

{% hint style="info" %} Documentation: https://docs.oxid-projects.com/oxid-rest-api/
Repository: https://github.com/OXIDprojects/oxid-rest-api {% endhint %}

About

This community project was started on the OXID Hackathon 2018.
It´s based on the PHP micro framework Lumen.

Status quo

This project is wip (work in progress). The API is functionally working and the first route articles exists.

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

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

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

  • 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