Skip to content

djurovicigoor/lara-json-response

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LaraJsonResponse

Latest Version on Packagist Total Downloads License: MIT Scrutinizer code quality (GitHub/Bitbucket) Scrutinizer build (GitHub/Bitbucket)

Laravel API wrapper for returning JSON response.

Installation

Via Composer

$ composer require djurovicigoor/larajsonresponse

Usage

The base method is laraResponse();

    return laraResponse();

JSON response of this method will be:

{
    "code": 200,
    "message": null,
    "data": null,
    "error": null
}

If you want to return success JSON response with data and status code 200, you have to use laraResponse($message , $data)->success()

    $data = ['name' => 'John Doe', 'location' => 'unknown' , 'age' => 24];
	
    return laraResponse("My message." , $data)->success();

JSON response of this method will be:

{
    "code": 200,
    "message": "My message.",
    "data": {
        "name": "John Doe",
        "location": "unknown",
        "age": 24
    },
    "error": null
}

If you want to return error JSON response with message, ERROR and status code 400, you have to use laraResponse($message , NULL , $error)->error()

    return laraResponse('My message.' , NULL , "TYPE_OF_ERROR")->error();

JSON response of this method will be:

{
    "code": 400,
    "message": "My message.",
    "data": null,
    "error": "TYPE_OF_ERROR"
}

If you want to return unauthorized JSON response response with 401 status code, you have to use laraResponse($message)->unAuthorized()

    return laraResponse('This action is unauthorized.')->unAuthorized();

JSON response of this method will be:

{
    "code": 401,
    "message": "This action is unauthorized.",
    "data": null,
    "error": null
}

If you want to return forbidden JSON response response with 403 status code, you have to use laraResponse($message)->forbidden()

    return laraResponse('Forbidden!')->forbidden();

JSON response of this method will be:

{
    "code": 403,
    "message": "Forbidden!",
    "data": null,
    "error": null
}

If you want to return not found JSON response with 404 status code , you have to use laraResponse($message)->notFound()

    return laraResponse('Not Found!')->notFound();

JSON response of this method will be:

{
    "code": 404,
    "message": "Not Found!",
    "data": null,
    "error": null
}

And finaly you can use laraResponse($message)->customCode($yourCustomCode) to return JSON response with yout custom code;

return laraResponse('My custom status code!')->customCode($yourCustomCode);

JSON response of this method will be:

{
    "code": $yourCustomCode,
    "message": "My custom status code!",
    "data": null,
    "error": null
}

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Donate

If you found this project helpful or you learned something from the source code and want to appreciate

Credits

License

MIT. Please see the license file for more information.

About

Laravel API wrapper for returning JSON response.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages