Laravel Api Response

, _(*1)

Standard API response to use with Laravel Framework, _(*2)

Compatibility

Laravel	PHP
5.0.x	>= 5.4
5.1.x	>= 5.5.9

Installation

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

"lucasandrade/laravel-apiresponse": "dev-master"

Then run composer update to get the package., _(*4)

Configuration - Laravel

Add this line of code to the providers array located in your config/app.php file:, _(*5)

Lucandrade\ApiResponse\ApiResponseServiceProvider::class,

Add this line to the aliases array:, _(*6)

'ApiResponse' => Lucandrade\ApiResponse\Facades\ApiResponse::class,

Run the vendor:publish command:, _(*7)

php artisan vendor:publish

Configuration - Lumen

Execute this command from your project path:, _(*8)

cp ./vendor/lucasandrade/laravel-apiresponse/src/config/apiresponse.php ./config

Uncomment the following line of your bootstrap/app.php file:, _(*9)

\\ $app->withFacades();

Add this line in the end of file:, _(*10)

$app->register(Lucandrade\ApiResponse\Lumen\ApiResponeServiceProvider::class);

Usage

Route::get('/api-response', function() {
    return ApiResponse::setPayload("Here's data")
        ->setStatusMessage("OK")
        ->setRequestCode(0)
        ->get();
});

Output:, _(*11)

{
    "status":true,
    "payload":"Here's data",
    "message":"OK",
    "completed_at":"2015-09-02 16:27:11",
    "code":0
}

To change response fields alter apiresponse.php file located in your config directory:, _(*12)

return [
    "keys" => [
        "status" => "{statusNameField}",
        "status_message" => "{messageNameField}",
        "request_code" => "{codeNameField}",
        "payload" => "{payloadNameField}",
        "time" => "{completedAtNameField}"
    ]
];