tyler36/response-macro

There is no license information available for the latest version (1.1) of this package.

Standardizing JSON responses

1.1 2018-07-20 06:03 UTC

Requires

• php: >=7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12
• squizlabs/php_codesniffer: ^3.3

Unknown License

• response
• service-provider
• laravel

README

These macros help to standardize api json response returns throughout the application. Inspired by Laravel Response Macros for APIs

Installation

• Install package

composer require tyler36/response-macro

Success

Returns payload ($data) with an optional HTTP status code ($statusCode) [Default: [HTTP status code 200]

response()->success($data);

EG.

response()->success(['earth' => 3, 'sun' => 'yellow'])

Returns HTTP status 200 with the following:

{"errors":false,"data":{"earth":3,"sun":"yellow"}}

noContent

Returns empty content with a HTTP status code 402

response()->noContent()

Error

Returns message ($message) content with an optional HTTP status code ($statusCode) [Default: HTTP status code 400]

response()->error($message);

Eg.

response()->error('There was an error.');

Returns HTTP status 400 with the following:

{"errors":true,"message":"There was an error."}

Eg.

response()->error('Not authorized!', 403);

Returns HTTP status 403 with the following:

{"errors":true,"message":"Not authorized!"}