aziz/laravel5-api-generator

Laravel API/Scaffold/CRUD Generator from just one command with including Controller, Repository, Model, Migrations, routes.php update.

Laravel API/Scaffold/CRUD Generator (Laravel5)

, _(*1)

I enjoy creating API's and I have worked on many projects that required them. But the problem I always faced was setting up all the boilerplate code. For example each end point needs a migration, model, controller, repository, and on and on. I wanted a way to streamline this process and that is how this package was born., _(*2)

This API generator allows you to use artisan commands to automatically generate all these files saving you time. Not only does it auto generate the files but it will set the namespaces., _(*3)

The artisan command can generate the following items: * Migration File * Model * Repository (optional) * Controller * View * index.blade.php * show.blade.php * create.blade.php * edit.blade.php * fields.blade.php * adjusts routes.php, _(*4)

And your simple CRUD API is ready in mere seconds., _(*5)

Here is the full documentation., _(*6)

Upgrade Guide from 1.0 to 1.1 or 1.2

1. Take a backup of your config/generator.php, _(*7)

2. Delete your config/generator.php, _(*8)

3. Change version in composer.json, _(*9)

   "require": {
       "mitulgolakiya/laravel-api-generator": "1.2.*"
   }

4. Run composer update., _(*10)

5. Run publish command again., _(*11)

   php artisan vendor:publish --provider="Mitul\Generator\GeneratorServiceProvider"

6. Replace your custom paths again in config/generator.php., _(*12)

7. Enjoy Upgrade :), _(*13)

Steps to Get Started

1. Add this package to your composer.json:, _(*14)

   "require": {
       "mitulgolakiya/laravel-api-generator": "1.2.*"
   }

2. Run composer update, _(*15)

   composer update

3. Add the ServiceProviders to the providers array in config/app.php.
   As we are using these two packages illuminate/html & laracasts/flash as a dependency.
   so we need to add those ServiceProviders as well., _(*16)

   'Illuminate\View\ViewServiceProvider',
   'Illuminate\Html\HtmlServiceProvider',
   'Laracasts\Flash\FlashServiceProvider',
   'Mitul\Generator\GeneratorServiceProvider'

Also for convenience, add these facades in alias array in config/app.php., _(*17)

    'Form'  => 'Illuminate\Html\FormFacade',
    'HTML'  => 'Illuminate\Html\HtmlFacade',
    'Flash' => 'Laracasts\Flash\Flash'

1. Publish generator.php, _(*18)

   php artisan vendor:publish --provider="Mitul\Generator\GeneratorServiceProvider"

2. Fire artisan command to generate API, Scaffold with CRUD views or both API as well as CRUD views., _(*19)

   php artisan mitul.generator:api ModelName
   php artisan mitul.generator:scaffold ModelName
   php artisan mitul.generator:scaffold_api ModelName

   e.g., _(*20)

   php artisan mitul.generator:api Project
   php artisan mitul.generator:api Post
   
   php artisan mitul.generator:scaffold Project
   php artisan mitul.generator:scaffold Post
   
   php artisan mitul.generator:scaffold_api Project
   php artisan mitul.generator:scaffold_api Post

3. Enter the fields with options
   , _(*21)

4. And you are ready to go. :), _(*22)

Documentation

Generator Config file

Config file (config/generator.php) contains path for all generated files, _(*23)

path_migration - Path where Migration file to ge generated
path_model - Path where Model file to ge generated
path_repository - Path where Repository file to ge generated
path_controller - Path where Controller file to ge generated
path_api_controller - Path where API Controller file to ge generated
path_views - Path where views will be created
path_request - Path where request file will be created
path_routes - Path of routes.php (if you are using any custom routes file)
, _(*24)

namespace_model - Namespace of Model
namespace_repository - Namespace of Repository
namespace_controller - Namespace of Controller
namespace_api_controller - Namespace of API Controller
namespace_request - Namespace for Request
, _(*25)

model_extend - Use custom Model extend
model_extend_namespace - Namespace of custom extended model
model_extend_class - Class name to extend
, _(*26)

api_prefix - API Prefix, _(*27)

Field Input

Here is the input for the fields by which you can specify Input., _(*28)

    fieldName:fieldType,options:fieldOptions

e.g.,, _(*29)

    email:string:unique
    email:string:unique,default('me@mitul.me')
    title:string,100
    price:flat,8,4

Parameters will be in the same sequence as Blueprint class function for all types. Option will be printed as it is given in input except unique & primary., _(*30)

API Response Structure

Remember: This response structure is based on the most of my API response structure, you can change it to your API response after file generation in controller., _(*31)

Success, _(*32)

    {
        "flag":true,
        "message":"success message",
        "data":{}
    }

data can be anything as per response., _(*33)

Failure, _(*34)

    {
        "flag":false,
        "message":"failure message",
        "code": 0
        "data":{}
    }

data will be optional. And code will be error code., _(*35)

Generated Views

While generating scaffold, all views are created with basic CRUD functionality., _(*36)

Views will be created in resources/views/modelName folder,, _(*37)

    index.blade.php - Main Index file for listing records
    create.blade.php - To insert a new record
    edit.blade.php - To edit a record
    fields.blade.php - Common file of all model fields, which will be used create and edit record
    show.blade.php - To display a record

Screenshots

Command Execution

, _(*38)

Generated Files & routes.php

, _(*39)

Migration File

, _(*40)

Model File

, _(*41)

Repository File

, _(*42)

Controller File

, _(*43)

View Files

, _(*44)

Credits

This API Generator is created by Mitul Golakiya., _(*45)

Bugs & Forks are welcomed :), _(*46)