Skip to content

Latest commit

 

History

History
290 lines (217 loc) · 7.26 KB

README.md

File metadata and controls

290 lines (217 loc) · 7.26 KB
Raw

Tapioca

Tapioca is a Composer package that allows you to use JSON:API with Laravel.

There are other Laravel packages that already do the same thing, and they probably do it much better. I felt like the other packages had too much boilerplate though, and I wanted to re-use my Laravel models as resources. I also wanted to add some features that aren't technically JSON:API, like creating/updating a regular record and related/included records at the same time. And programming's kinda my thing, so I thought writing this could be fun. (Spoiler alert: it wasn't. Okay, maybe just a little.)

Features

  • Add/update/delete/view/view-all
  • Sparse fieldsets: ?fields[articles]=title
  • Filter (with operation) ?filter[slug][eq]=foo
  • Include relationships: ?include=user
  • Pagination: ?page[size]=10&page[number]=1
  • Sort: ?sort=-created_at,user.username

Requirements

Install

Warning: This package is still a work-in-progress. Use at your own risk.

Run:

composer config repositories.tapioca vcs git@github.com:jlbelanger/tapioca.git
composer require jlbelanger/tapioca @dev
php artisan vendor:publish --provider="Jlbelanger\Tapioca\TapiocaServiceProvider" --tag="config"

Setup

Add the following to the dontReport property in app/Exceptions/Handler.php:

protected $dontReport = [
	\Jlbelanger\Tapioca\Exceptions\JsonApiException::class,
];

Add the following to the register function in the same file (app/Exceptions/Handler.php):

public function register() : void
{
	$this->renderable(function (\Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException $e) {
		return response()->json(['errors' => [['title' => 'URL does not exist.', 'status' => '404', 'detail' => 'Method not allowed.']]], 404);
	});

	$this->renderable(function (\Jlbelanger\Tapioca\Exceptions\JsonApiException $e) {
		return response()->json(['errors' => $e->getErrors()], $e->getCode());
	});

	$this->renderable(function (\Symfony\Component\HttpKernel\Exception\HttpException $e) {
		return response()->json(['errors' => [['title' => $e->getMessage(), 'status' => $e->getStatusCode()]]], $e->getStatusCode());
	});

	$this->renderable(function (\Illuminate\Http\Exceptions\ThrottleRequestsException $e) {
		return response()->json(['errors' => [['title' => 'Please wait before retrying.', 'status' => '429']]], 429);
	});

	$this->renderable(function (\Illuminate\Validation\ValidationException $e) {
		$output = [];
		$errors = $e->validator->errors()->toArray();
		foreach ($errors as $pointer => $titles) {
			foreach ($titles as $title) {
				$output[] = [
					'title' => $title,
					'source' => [
						'pointer' => '/' . str_replace('.', '/', $pointer),
					],
					'status' => '422',
				];
			}
		}
		return response()->json(['errors' => $output], 422);
	});

	$this->renderable(function (\Throwable $e) {
		$code = $e->getCode() ? $e->getCode() : 500;
		$error = ['title' => 'There was an error connecting to the server.', 'status' => (string) $code];
		if (config('app.debug')) {
			$error['detail'] = $e->getMessage();
			$error['meta'] = [
				'exception' => get_class($e),
				'file' => $e->getFile(),
				'line' => $e->getLine(),
				'trace' => $e->getTrace(),
			];
		}
		return response()->json(['errors' => [$error]], $code);
	});
}

Update app/Http/Middleware/Authenticate.php:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Auth\Middleware\Authenticate as Middleware;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;

class Authenticate extends Middleware
{
	/**
	 * Handles an incoming request.
	 *
	 * @param  Request     $request
	 * @param  Closure     $next
	 * @param  string|null $guard
	 * @return mixed
	 */
	public function handle(Request $request, Closure $next, $guard = null)
	{
		if (!Auth::guard($guard)->check()) {
			abort(404);
		}

		return $next($request);
	}
}

Then, you can either create each resource automatically or manually.

Option A: Automatically

To automatically generate a controller, model, and route, run the following command (replacing "User" with the name of the resource):

php artisan make:tapioca User

Option B: Manually

The controller must extend ResourceController (or AuthorizedResourceController if you are using Sanctum):

<?php

namespace App\Http\Controllers\Api;

use Jlbelanger\Tapioca\Controllers\ResourceController;

class UserController extends ResourceController
{
	// Additional routes can be defined here. Otherwise, the controller should be empty.
}

The model must include the Resource trait:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Jlbelanger\Tapioca\Traits\Resource;

class User extends Model
{
	use Resource;
}

The route must be defined in routes/api.php (optionally including 'auth' or 'auth:sanctum' or similar in the middleware):

<?php

use Illuminate\Support\Facades\Route;

Route::apiResource('users', \App\Http\Controllers\Api\UserController::class)->middleware(['api']);

Usage

Fields

GET /articles?fields[articles]=title
GET /articles/1?fields[articles]=title
GET /articles/1?include=user&fields[articles]=title&fields[users]=username

Filter

GET /articles?filter[slug][eq]=foo
GET /articles?filter[slug][ne]=foo
GET /articles?filter[slug][like]=foo%
GET /articles?filter[slug][like]=%foo
GET /articles?filter[slug][like]=%foo%
GET /articles?filter[slug][notlike]=foo%
GET /articles?filter[slug][notlike]=%foo
GET /articles?filter[slug][notlike]=%foo%
GET /articles?filter[slug][in]=foo,bar
GET /articles?filter[slug][notin]=foo,bar
GET /articles?filter[slug][null]=1
GET /articles?filter[slug][notnull]=1
GET /articles?filter[word_count][gt]=50
GET /articles?filter[word_count][lt]=50
GET /articles?filter[word_count][ge]=50
GET /articles?filter[word_count][le]=50
GET /articles?filter[user.id][eq]=1

Include

GET /articles?include=user
GET /articles?include=tags,user
GET /articles/1?include=user

Pagination

GET /users?page[size]=10
GET /users?page[size]=10&page[number]=1

Sort

GET /users?sort=username
GET /users?sort=-username
GET /users?sort=username,email
GET /articles?sort=user.username

Examples

Development

Requirements

Setup

git clone https://github.com/jlbelanger/tapioca.git
cd tapioca
composer install

Lint

./vendor/bin/phpcs

Test

./vendor/bin/phpunit

Notes

Multipart PUT requests

PHP does not support multipart PUT requests. As a workaround, you can install the apfd PECL extension..

To install the extension on Ubuntu (replace 7.4 with your PHP version):

apt-get install php-pear
apt-get install php7.4-dev
pecl install apfd
echo "extension=apfd.so" >> /etc/php/7.4/fpm/php.ini

Then restart PHP (eg. service php7.4-fpm restart)