8000 GitHub - emancypage/oxid-rest-api: OXID 6 REST API based on Lumen, powered by OXID Community Hackathon 2018.
[go: up one dir, main page]

Skip to content

emancypage/oxid-rest-api

 
 

Repository files navigation

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

About

OXID 6 REST API based on Lumen, powered by OXID Community Hackathon 2018.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 96.2%
  • Dockerfile 2.6%
  • Shell 1.2%
0