Download the PHP package fuzz/api-server without Composer

Laravel API Server

A framework for rapid REST API development.

Installation

1. Require the repository in your composer.json
2. Add the ApiServerServiceProvider to your application and publish its config artisan vendor:publish --provider="Fuzz\ApiServer\Providers\ApiServerServiceProvider".

3. Extend the packaged route provider for your app:

4. Extend the packaged exception handler for your app:

Usage

Basic usage

Register a base controller extending Fuzz\ApiServer\Routing\Controller:

Register routes pointing to extensions of your base controller. Make a catch-all route to send all other requests through your base controller.

ResourceControllers

Resource controllers extend functionality of fuzz/magic-box repositories and provide CRUD and authorization functionality out of the box.

Your application should extend the base fuzz/api-server Resource controller:

And to define a route for a resource in your routes.php: $router->restful('User');. The restful route macro is defined in Fuzz\ApiServer\Providers\RouteServiceProvider.

If any resources need to override the default functionality, you can create a specific ResourceController by extending your application's base ResourceController:

app/Http/Controllers/Resources/Users.php:

You can then point your restful route to your custom ResourceController: in routes.php: $router->restful('Run', 'Resources\Users');

Returning that sweet, sweet, data

Send mixed data:

Send any arrayable data:

Send any paginated data:

Send RESTful errors with error codes and optional data:

Raise RESTful error exceptions outside of the controller context:

Require the user to provide certain parameters:

Read a list of certain parameters:

Special handling (with de-duplication) for reading arrays:

Handles nested JSON and form properties just fine:

CORS Middleware

Configuring the CORS middleware is as simple as adding Fuzz\ApiServer\Routing\CorsMiddleware to the $middleware array in app/Http/Kernel.php.