asmiarowski/laravel5-api-generator

Artisan generator for API reasource.

v0.4.1 2017-06-04 19:46 UTC

Requires

• php: >=5.5.0
• icanboogie/inflector: ^1.3

Requires (Dev)

• phpspec/phpspec: ~2.1

MIT

• Artur Śmiarowski

• laravel
• REST API
• generators

README

Generates boilerplate for laravel REST API: migration, controller, model, request and route.

Installation

composer require --dev asmiarowski/laravel5-api-generator

Add this to app\Providers\AppServiceProvider inside boot() method:

if ($this->app->environment() == 'local') {
    $this->app->register('Smiarowski\Generators\GeneratorsServiceProvider');
}

For POST / PUT data to work you either have to send your request with Accept: application/json header or set up json responses globally in app/Http/Requests/Request.php like so:

/**
 * Overwrite Laravel Request method because API is always returning json
 * @return bool
 */
public function wantsJson()
{
    return true;
}

Command syntax

php artisan make:api-resource <table_name> --schema="<column_name>:<column_type>(<arguments>):<option>(<arguments>); [...]" --softdeletes

Command options

--schema - required, schema of your migration, validators will be set based on fields and types specified.

--softdeletes - optional, add softDeletes() to migration

Column types

http://laravel.com/docs/5.1/migrations#creating-columns

Custom types

- email - puts string type column in your migration and email validation for your request

- url - puts text type column in your migration and url validation in request

Column options

foreign, index, unique, default, nullable, first, after, unsigned

Example command

php artisan make:api-resource emails --schema="email:email:unique; title:string; body:text; status:integer:default(1); user_id:integer:foreign(users)" --softdeletes

Creates:

app/Http/Controllers/EmailController.php

app/Htpp/Requests/EmailRequest.php

app/Email.php

database/migrations/*timestamp*_create_emails_table.php

And appends resource routes to app/routes.php with pattern for id of the resource.