ftxrc/apicontroller

Simplified API controller, inspired by Jeffrey Way. Compatible with Laravel 5+ and Lumen 5+. Forked from eventhomes

0.1.8 2015-06-23 03:25 UTC

Requires

• php: >=5.5.9
• illuminate/http: ~5.0
• illuminate/support: ~5.0

MIT

• Bill Richards

• api
• laravel
• fractal
• lumen
• api controller

README

Fork of EventHomes' APIController trait. Has a few fixes and customizations that make it more useful, like prettyprinting and raw responses.

A simple api controller helper trait, compatible with Lumen 5+ and Laravel 5+. The goal of this project is to make creating API projects simple. Inspired by Jeffrey Way (https://www.laracasts.com)

Installation

composer require eventhomes/laravel-apicontroller

Basic Setup/Usage

...
use EventHomes\Api\ApiController;

class MyController extends Controller {

    use ApiController;
    
    public function index() {
        return $this->respond(['status' => 'hello world']);
    }
    
}

Api Helper functions

Please browse through the source to see a full list.

//200 response
$this->respond();

//201 response
$this->respondCreated();

//500 error
$this->respondServerError();

//422 error
$this->respondUnprocessable();

//General error
$this->respondWithError('message here');

Add Fractal Helpers

Please use [https://github.com/eventhomes/laravel-fractalhelper]