Slim 3 Eloquent JSON API Server Package

Compatible with Slim Framework 3.0, 3.1

• A JSON API Transformer that will allow you to convert any mapped object into a valid JSON API resource.
• Controller boilerplate to write a fully compiliant JSON API Server using your exisiting Eloquent Models.
• Works with Slim Framework 3 and Eloquent 5.

• Installation
• Configuration for Slim 3 and Eloquent
  • Step 1: Define Mappings
  • Step 2: Define Dependency
  • Step 4: Usage
• JsonApiController
• Examples: Consuming the API
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
• GET Query Params: include, fields, sort and page
• POST/PUT/PATCH with Relationships
• Custom Response Headers

Installation

Use Composer to install the package:

composer require szymondukla/slim3-json-transformer

Configuration for Slim 3 and Eloquent

Step 1: Define Mappings

Open up your settings file and add an entry for your mappings:

return [
    'settings' => [

        // JSON-API settings
        'json-api' => [
            'mappings' => [
                Mappings\ContactMapping::class,
                Mappings\OwnerMapping::class
            ]
        ]

    ]
];

Step 2: Define Dependency

Open up your dependencies file and add an entry for the JsonApiSerializer, using the mappings you defined in the settings.

$container[SzymonDukla\Slim3\JsonApi\JsonApiSerializer::class] = function (ContainerInterface $c) {
    $mappings = $c->get('settings')['json-api']['mappings'];

    $mapper = new SzymonDukla\Slim3\JsonApi\Mapper\Mapper($mappings);

    $mappingHelper = new SzymonDukla\Slim3\JsonApi\Mapper\MappingHelper();
    $parsedRoutes = $mappingHelper->parseRoutes($mapper);

    $transformer = new AmaranthCloud\Api\JsonApi\JsonApiTransformer($parsedRoutes);

    return new SzymonDukla\Slim3\JsonApi\JsonApiSerializer($transformer);
};