wboyz/laravel-api-responses

Api response helper for Laravel.

v0.5.2 2016-04-24 11:59 UTC

This package is auto-updated.

Last update: 2024-09-29 03:57:53 UTC


README

License Latest Stable Version

This is a helper package based on the Laracasts Incremental APIs tutorial series for returning correctly formed json responses for API calls.

Installation

Require this package with composer:

composer require wboyz/laravel-api-responses

After updating composer, add the ServiceProvider to the providers array in config/app.php:

Laravel 5.x:

WBoyz\LaravelApiResponses\WResponseServiceProvider::class,

If you want to use the facade, add this to your facades in app.php:

'WResp' => WBoyz\LaravelApiResponses\Facades\WResponse::class,

Usage

You can return responses using the Facade (when added), using the supported methods:

public function index() {
    return WResp::respondNotFound('Not Found!');
}

You can now return responses using the global helper function wresponse:

public function index() {
    return wresponse()->respondNotFound('Not Found!');
}