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

, _(*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

Add echo-it/laravel-jsonapi to your composer.json dependency list (version 2.0.0 at the minimum for laravel 5 support), _(*5)
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)

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');
```
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)

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)

Resource Representations as resource objects
Resource Relationships
- Only through Inclusion of Linked Resources
Compound Documents
Sorting
Filtering
[Pagination] (http://jsonapi.org/format/#fetching-pagination)

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

Nested requests to fetch relations, e.g. /users/[id]/friends
Resource URLs
Requests for multiple individual resources, e.g. /users/1,2,3
Sparse Fieldsets, _(*28)
Some kind of caching mechanism, _(*29)

The Versions

31/08 2016

dev-master

9999999-dev

library laravel-jsonapi

echo-it/laravel-jsonapi

The README.md

JSON API helpers for Laravel 5

Installation

Requirements

Using laravel-jsonapi

Current features

Wishlist

The Versions

dev-master

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.4.2

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

2.4.1

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.4

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

1.x-dev

The Requires

The Development Requires

by Ronni Egeriis Persson

v1.3

The Requires

The Development Requires

by Ronni Egeriis Persson

v1.2.16

The Requires

The Development Requires

by Ronni Egeriis Persson

v1.2.15

The Requires

The Development Requires

by Ronni Egeriis Persson

v2.3.1

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.3

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.2

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.1

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v2.0

The Requires

The Development Requires

by Ronni Egeriis Persson

by Jared Chapiewsky

v1.2.14

The Requires

The Development Requires

by Ronni Egeriis Persson

v1.2.13

The Requires

The Development Requires

by Ronni Egeriis Persson

v1.2.12