For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

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.

ContributeChangelog

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

Last updated