iramgutierrez/lumen-resource-api

Create a resource API for Lumen 5.3: entity, repository, manager, validator, controller, migration, table , route and documentation

Resource API Generator for Lumen 5.3

, _(*1)

, _(*2)

Full resource generator for API RESTful,, _(*3)

This package implements the layers pattern design, include:, _(*4)

• Entity
• Controller
• Manager
• Validator
• Repository
• Migration
• Route
• Documentation (Require apidocjs installed)

Installation

Add the following line to your composer.json file:, _(*5)

"iramgutierrez/lumen-resource-api": "1.3.*"

Run composer update to get the package., _(*6)

Once composer has installed the package add this line of code in your bootstrap/app.php file:, _(*7)

$app->register(\IramGutierrez\API\APIServiceProvider::class);

Migrations and Configuration Publishing

Add this line of code to the $commands protected array located in your app/Console/Kernel.php file:, _(*8)

\Laravelista\LumenVendorPublish\VendorPublishCommand::class

Run php artisan vendor:publish to publish this package configuration and migrations. Afterwards you can edit the file config/resource_api.php to set the namespace for the resources generated., _(*9)

Run migration to create required tables, _(*10)

php artisan migrate

Usage

Now, you should have available the Artisan command: create-resource-api and can be used like this:, _(*11)

php artisan create-resource-api {Entity}

Example

Run, _(*12)

php artisan create-resource-api Test

And, the command ask you for the table name:, _(*13)

Table name [tests]:

namespace:, _(*14)

Path name [API]:

prefix route:, _(*15)

Prefix route []:

if do you want generate documentation:, _(*16)

Generate documentation? (Require apidocjs) (yes/no) [yes]:

if do you want generate the migration file:, _(*17)

Generate migration? (yes/no) [yes]:

if do you want run migration:, _(*18)

Run migration? (yes/no) [yes]:

if do you want add the route resource in routes.php file:, _(*19)

Add routes resource? (yes/no) [yes]:

and if do you want add some middleware:, _(*20)

Middlewares or middleware groups (comma separated) []:

When the execution is finished, you should have available the following functional routes:, _(*21)

License

The Lumen Resource API package is released under the MIT License., _(*22)