2017 © Pedro Peláez
 

library laravel-api-responses

Helper methods for Laravel API Responses

image

dees040/laravel-api-responses

Helper methods for Laravel API Responses

  • Wednesday, March 7, 2018
  • by dees040
  • Repository
  • 1 Watchers
  • 0 Stars
  • 324 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 9 Versions
  • 7 % Grown

The README.md

Laravel API Responses

Latest Stable Version Total Downloads Build status , (*1)

A very small package which helps you to easily returning readable API responses., (*2)

Installation

Install the package via Composer., (*3)

composer require dees040/laravel-api-responses

You're ready to go!, (*4)

Usage

Just use one of the helper functions and you're good to go., (*5)

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UsersController extends Controller
{
    /**
     * Show the given user.
     *
     * @param  \App\User  $user
     * @return \Illuminate\Http\Response
     */
    public function show(User $user)
    {
        if (! $user->isAdmin()) {
            return forbidden();
        }

        return ok($user);
    }
}

Methods

All methods accept a $data parameter. This can be any data which can be used in a JSON response, such as strings, integers, arrays, models, etc.., (*6)

Method Status Code
ok($data) 200
created($data) 201
accepted($data) 202
no_content() 204
bad_request($message, $errors) 400
unauthenticated($message, $errors) 401
forbidden($message, $errors) 403
not_found($message, $errors) 404
method_not_allowed($message, $errors) 405
not_acceptable($message, $errors) 406
teapot($message, $errors) 418
unprocessable_entity($message, $errors) 422

Custom response (code)

If you'd wish to send a status code which is not in the list you could use the json_response($data = null, $status = 200) helper function. Here you can find a cheat sheet for HTTP status codes or use my personal favorite http.cat 😉., (*7)

If you want to send error response you can use the error_json_response($message = '', $errors = [], $status = 400). This method will send an json response like this:, (*8)

error_json_response('User not found.', [
    'id' => 'The ID does not exists.'
]);

Output:, (*9)

{
  "message": "User not found.",
  "errors": {
    "id": "The ID does not exists."
  }
}

The Versions

07/03 2018

dev-master

9999999-dev

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar dees040

07/03 2018

0.2.2

0.2.2.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar dees040

07/03 2018

0.2.1

0.2.1.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar dees040

07/03 2018

0.2.0

0.2.0.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar dees040

14/02 2018

0.1.4

0.1.4.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

by Avatar dees040

16/08 2017

0.1.3

0.1.3.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

by Avatar dees040

01/08 2017

0.1.2

0.1.2.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

by Avatar dees040

01/08 2017

0.1.1

0.1.1.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

by Avatar dees040

01/08 2017

0.1

0.1.0.0

Helper methods for Laravel API Responses

  Sources   Download

MIT

The Requires

 

by Avatar dees040