datakrama/lapires

Lapires - Laravel API Response, generalizing all response from your API server

v2.1.0 2020-11-06 08:53 UTC

Requires

• php: ^7.2|^8.0
• illuminate/support: ^7.0|^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• orchestra/testbench: ^5.0|^6.0
• phpro/grumphp: ^1.1
• phpunit/phpunit: ^8.0|^9.0

MIT

• Ahmad Husen

README

Lapires is simple Laravel package for generalizing all default response to API-friendly response. With this package, you will have a properly formatted JSON response. However, the response format is fixed, you can not change the format.

Requirements

• Laravel 7.x|8.x

Laravel Compatibility

Laravel	Package
6.x	1.x
7.x	2.x
8.x	2.x

Installation

$ composer require datakrama/lapires:"^2.0"

Config (Optional)

If you need to disable custom exception response from this package, publish the config file, and change exception option to false.

$ php artisan vendor:publish --provider="Datakrama\Lapires\LapiresServiceProvider"

Usages

All responses will be formatted as follows:

// Success response

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

// Error response

{
    "success": false,
    "message": ...,
    "errors": {
        ...
    }
}

General

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Datakrama\Lapires\Traits\ApiResponser;

class HomeController extends Controller
{
    use ApiResponser;

    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Show the application dashboard.
     *
     * @return \Illuminate\Contracts\Support\Renderable
     */
    public function index()
    {
        return view('home');
    }

    /**
     * Success response
     *
     * @return void
     */
    public function success()
    {
        $data = ['foo' => 'bar'];
        $message = 'This is example success response.';
        $code = 200;
        return $this->successResponse($data, $message, $code);
    }

    /**
     * Error response
     *
     * @return void
     */
    public function error()
    {
        $code = 500;
        $message = 'This is example error response.';
        $errors = ['foo' => 'bar'];
        return $this->successResponse($code, $message, $errors);
    }
}

Thanks

This package is made because inspiration from https://github.com/Cerwyn/laravel-generalizing-response.

Licence

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