Download the PHP package alchemy/rest-bundle without Composer

Alchemy - Rest bundle

Features

• Provides automatic date parameter parsing using a predefined format and timezone
• Provides automatic sort and pagination parameter parsing
• Provides standardized error responses in AJAX/JSON contexts

Configuration

Enable the bundle by adding it to the app kernel.

By default, all listeners are enabled. You can add the following section to your config.yml to alter the behavior of the listeners:

Note The following configuration matches the default settings

Usage

Automatic date parsing

To activate date conversions on request parameters, you must explicitly define which parameters will be parsed as dates on a per-route basis in your routing files.

Example

Assuming that your requests will contain a from and a to parameter:

You can now type-hint your controller method as follows:

Automatic sort and pagination

To activate automatic sorting and pagination parameter parsing, you must explicitly activate them on a per-route basis in your routing files.

Simple example

You can now type-hint your controller method as follows:

Transforming controller results into JSON responses:

This listener is always activated. To use it, you must first write a Transformer (see the League/Fractal documentation for information on transformers), and define it as a tagged service in your dependency injection configuration:

Then in your routing file, you need to specify the transformer for a given route:

You can use the list parameter in your route defaults to specifiy whether the controller result should be handled as a list or as a simple object. If your controller returns an instance of PagerFanta (you must include the library in your project as it is an optional dependency), the response will automatically include a meta property containing a pagination property with the pagination metadata.