oxid-community / oxid-rest-api
REST API for OXID eShop based on Laravel Lumen Framework.
Installs: 94
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 10
Forks: 8
Open Issues: 2
Type:project
Requires
- php: >=7.1.3
- laravel/lumen-framework: 5.7.*
- vlucas/phpdotenv: ~2.2
Requires (Dev)
- fzaninotto/faker: ~1.4
- mockery/mockery: ~1.0
- phpunit/phpunit: ~7.0
This package is auto-updated.
Last update: 2024-10-29 05:10:54 UTC
README
{% 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
- Tobias Merkl | @tabsl | proudcommerce.com
- Stefan Moises | @upsettweety | rent-a-hero.de