DEV Community

Mahmoud Italy
Mahmoud Italy

Posted on • Updated on

Larafast/fastApi package

Larafast FastAPI

Scrutinizer Code Quality
Build Status
Code Intelligence Status

What does mean FastAPI:

A Fastapi Laravel package to help you generate CRUD API Controllers and Resources, Model.. etc

What actually do?

Suppose you are building an api, and you want to create controller and resources and model and factory.. etc, then you have to do a ton of other tedious and to be honest, boring things like creating migrations, model factories, the controller, form validation and adding all !.

So what FastAPI does is when you tell it the model name, it will do all those boring things. When it's done you have the following:

  • Blog.php
  • BlogController.php ship with code already exists
  • BlogStoreRequest.php and BlogUpdateRequest.php
  • BlogResoure.php
  • Timestamped create_blogs_table.php migration file
  • BlogFactory.php

Installation

composer require larafast/fastapi --dev

Then publish the config

php artisan vendor:publish --tag=fastApi

Example

php artisan fastApi Blog

Once done, it will show you the details of the files generated.

Factory created successfully

Created Migration: 2020_07_14_125128_create_blogs_table

Model created successfully

Controller created successfully

Request created successfully

Request created successfully

Resource created successfully

Snapshot of BlogController

namespace App\Http\Controllers;

use App\Blog;
use Illuminate\Http\Request;
use App\Http\Requests\BlogUpdateRequest;
use App\Http\Requests\BlogStoreRequest;
use App\Http\Resources\BlogResource;

class BlogController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $rows = BlogResource::collection(Blog::fetchData(request()->all()));
        return response()->json(['data' => $rows], 200);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param
  BlogStoreRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(BlogStoreRequest $request)
    {
        try {
            Blog::create($request->all());
            return response()->json(['message' => ''], 201);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to create entry, '. $e->getMessage()], 500);
        }
    }

    /**
     * Display the specified resource.
     *
     * @param
  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function show(Blog $blog)
    {
        $row = new BlogResource(Blog::findOrFail($blog));
        return response()->json(['row' => $row], 200);
    }

    /**
     * Update the specified resource in storage.
     *
     * @param
  OrderUpdateRequest  $request
     * @param
  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function update(BlogUpdateRequest $request, Blog $blog)
    {
        try {
            $blog->update($request->all());
            return response()->json(['message' => ''], 200);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to update entry, '. $e->getMessage()], 500);
        }
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param
  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function destroy(Blog $blog)
    {
        try {
            $blog->delete();
            return response()->json(['message' => ''], 200);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to delete entry, '. $e->getMessage()], 500);
        }
    }
}

Snapshot of Blog Model

namespace App;

// use Stroage;
use Illuminate\Database\Eloquent\Model;
// use Illuminate\Database\Eloquent\SoftDeletes;

class Blog extends Model
{
    // use SoftDeletes;
    protected $guarded = [];

    // imageable polymorphic
    public function image() {
        return $this->morphOne(Image::class, 'imageable');
    }

    // handle attributes
    public function setImageAttribute($value){
        $imageName = time().'.'.$value->extension();  
        Storage::disk('public')->put('uploads/'.$imageName, $value);
        $this->image()->save($imageName);
    }

    // fetch Data
    public static function fetchData($value='')
    {
        // this way will fire up speed of the query
        $obj = self::query();

          // langauges in case you use multilanguages transactions package..
          if(isset($value['locale'])) {
             app()->setLocale($value['locale']);
          }

          // search for multiple columns..
          if(isset($value['search'])) {
            $obj->where(function($q){
                $q->where('title', 'like','%'.$value['search'].'%');
                $q->orWhere('body', 'like', '%'.$value['search'].'%');
                $q->orWhere('id', $value['search']);
            });
          }

          // order By..
          if(isset($value['order'])) {
            $obj->orderBy('id', $value['order']);
          } else {
            $obj->orderBy('id', 'DESC');
          }



          // feel free to add any query filter as much as you want...




        $obj = $obj->paginate($value['paginate'] ?? 10);
        return $obj;
    }
}

Snapshot of Blog Resource

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class BlogResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param
  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id'            => $this->id,
            'encrypt_id'    => encrypt($this->id),
            // 'image'         => ($this->image) ? $this->image->url : NULL,

            // 'title'      => $this->title,
            // 'body'       => $this->body,

            'dateForHumans' => $this->created_at->diffForHumans(),
            'timestamp'     => $this->created_at
        ];
    }
}

Now add the necessary fields and run

php artisan migrate

And that saved you an hour worth of repetitive and boring work which you can spend on more important development challenges.

Security

If you discover any security related issues, please email mahmoud.italy@outlook.com.

Credits

License

The MIT License (MIT). Please see License File for more information.

Discussion (2)

Collapse
brunowmoreno profile image
Bruno Queiroz

Awesome , thanks a lot!

Collapse
mahmouditaly profile image
Mahmoud Italy Author

You are welcome :)