2017 © Pedro PelĂĄez
 

library laravel-jsonapi

image

echo-it/laravel-jsonapi

  • Wednesday, August 31, 2016
  • by egeriis
  • Repository
  • 7 Watchers
  • 155 Stars
  • 1,571 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 28 Forks
  • 9 Open issues
  • 33 Versions
  • 1 % Grown

The README.md

!!! Project abandoned. See cloudcreativity/laravel-json-api for a great alternative., (*1)

JSON API helpers for Laravel 5

Build Status, (*2)

Make it a breeze to create a jsonapi.org compliant API with Laravel 5., (*3)

This library strives to be up to date with the latest JSON API updates—as the spec is still a work in progress. If you notice that something is missing, please contribute!, (*4)

Installation

  1. Add echo-it/laravel-jsonapi to your composer.json dependency list (version 2.0.0 at the minimum for laravel 5 support), (*5)

  2. Run composer update., (*6)

Requirements

  • PHP 5.4+
  • Laravel 5

Using laravel-jsonapi

This library is made with the concept of exposing models in mind, as found in the RESTful API approach., (*7)

In few steps you can expose your models:, (*8)

  1. Create a route to direct the requests, (*9)

    In this example, we use a generic route for all models and HTTP methods:, (*10)

    Route::any('{model}/{id?}', 'ApiController@handleRequest');
    
  2. Create your controller to handle the request, (*11)

    Your controller is responsible to handling input, instantiating a handler class and returning the response., (*12)

    ```php <?php namespace App\Http\Controllers;, (*13)

use EchoIt\JsonApi\Request as ApiRequest; use EchoIt\JsonApi\ErrorResponse as ApiErrorResponse; use EchoIt\JsonApi\Exception as ApiException; use Request;, (*14)

class ApiController extends Controller { public function handleRequest($modelName, $id = null) { /** * Create handler name from model name * @var string */ $handlerClass = 'App\Handlers\' . ucfirst($modelName) . 'Handler';, (*15)

    if (class_exists($handlerClass)) {
        $url = Request::url();
        $method = Request::method();
        $include = ($i = Request::input('include')) ? explode(',', $i) : $i;
        $sort = ($i = Request::input('sort')) ? explode(',', $i) : $i;
        $filter = ($i = Request::except('sort', 'include', 'page')) ? $i : [];
        $content = Request::getContent();

        $page = Request::input('page');
        $pageSize = null;
        $pageNumber = null;
        if($page) {
            if(is_array($page) && !empty($page['size']) && !empty($page['number'])) {
                $pageSize = $page['size'];
                $pageNumber = $page['number'];
            } else {
                 return new ApiErrorResponse(400, 400, 'Expected page[size] and page[number]');
            }
        }
        $request = new ApiRequest(Request::url(), $method, $id, $content, $include, $sort, $filter, $pageNumber, $pageSize);
        $handler = new $handlerClass($request);

        // A handler can throw EchoIt\JsonApi\Exception which must be gracefully handled to give proper response
        try {
            $res = $handler->fulfillRequest();
        } catch (ApiException $e) {
            return $e->response();
        }

        return $res->toJsonResponse();
    }

    // If a handler class does not exist for requested model, it is not considered to be exposed in the API
    return new ApiErrorResponse(404, 404, 'Entity not found');
}

} ```, (*16)

  1. Create a handler for your model, (*17)

    A handler is responsible for exposing a single model., (*18)

    In this example we have create a handler which supports the following requests:, (*19)

    • GET /users (ie. handleGet function)
    • GET /users/[id] (ie. handleGet function)
    • PUT /users/[id] (ie. handlePut function)

    Requests are automatically routed to appropriate handle functions., (*20)

    ```php <?php namespace App\Handlers;, (*21)

use Symfony\Component\HttpFoundation\Response; use App\Models\User;, (*22)

use EchoIt\JsonApi\Exception as ApiException; use EchoIt\JsonApi\Request as ApiRequest; use EchoIt\JsonApi\Handler as ApiHandler; use Request;, (*23)

/** * Handles API requests for Users. */ class UsersHandler extends ApiHandler { const ERROR_SCOPE = 1024;, (*24)

/*
* List of relations that can be included in response.
* (eg. 'friend' could be included with ?include=friend)
*/
protected static $exposedRelations = [];

/**
 * Handles GET requests. 
 * @param EchoIt\JsonApi\Request $request
 * @return EchoIt\JsonApi\Model|Illuminate\Support\Collection|EchoIt\JsonApi\Response|Illuminate\Pagination\LengthAwarePaginator
 */
public function handleGet(ApiRequest $request)
{
    //you can use the default GET functionality, or override with your own 
    return $this->handleGetDefault($request, new User);
}

/**
 * Handles PUT requests. 
 * @param EchoIt\JsonApi\Request $request
 * @return EchoIt\JsonApi\Model|Illuminate\Support\Collection|EchoIt\JsonApi\Response
 */
public function handlePut(ApiRequest $request)
{
    //you can use the default PUT functionality, or override with your own
    return $this->handlePutDefault($request, new User);
}

} ```, (*25)

> **Note:** Extend your models from `EchoIt\JsonApi\Model` rather than `Eloquent` to get the proper response for linked resources.

Current features

According to jsonapi.org:, (*26)

The features in the Handler class are each in their own function (eg. handlePaginationRequest, handleSortRequest, etc.), so you can easily override them with your own behaviour if desired., (*27)

Wishlist

The Versions

31/08 2016

dev-master

9999999-dev

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

29/10 2015
07/10 2015
28/09 2015

v2.4

2.4.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

01/09 2015

1.x-dev

1.9999999.9999999.9999999-dev

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

01/09 2015

v1.3

1.3.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

12/08 2015

v1.2.16

1.2.16.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

12/08 2015

v1.2.15

1.2.15.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

03/08 2015

v2.3.1

2.3.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

12/05 2015

v2.3

2.3.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

06/05 2015

v2.2

2.2.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

29/04 2015

v2.1

2.1.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

03/03 2015

v2.0

2.0.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson
by Jared Chapiewsky

03/03 2015

v1.2.14

1.2.14.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

13/02 2015

v1.2.13

1.2.13.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

16/12 2014

v1.2.12

1.2.12.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

16/12 2014

v1.2.11

1.2.11.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

14/10 2014

v1.2.10

1.2.10.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

23/09 2014

v1.2.9

1.2.9.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

22/09 2014

v1.2.8

1.2.8.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

16/09 2014

v1.2.7

1.2.7.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

10/09 2014

v1.2.6

1.2.6.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

01/08 2014

v1.2.5

1.2.5.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

31/07 2014

v1.2.4

1.2.4.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

31/07 2014

v1.2.3

1.2.3.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

30/07 2014

v1.2.2

1.2.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

30/07 2014

v1.2.1

1.2.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

29/07 2014

v1.2

1.2.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

29/07 2014

v1.1.3

1.1.3.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

23/07 2014

v1.1.2

1.1.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

22/07 2014

v1.1.1

1.1.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

22/07 2014

v1.1

1.1.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ronni Egeriis Persson

22/07 2014

v1.0

1.0.0.0

  Sources   Download

MIT

The Requires

 

by Ronni Egeriis Persson