LimoncelloBundle
LimoncelloBundle is an integration bundle for neomerx/json-api and Symfony., (*1)
, (*2)
Install
- Download LimoncelloBundle using composer
$ composer require plehatron/limoncello-bundle "dev-master@dev"
- Enable the bundle
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Plehatron\LimoncelloBundle\PlehatronLimoncelloBundle(),
// ...
);
}
Create and register JSON API Schema classes
See CategorySchema file from integration tests for an
example on how to write JSON API Schema classes., (*3)
Register a map of schema and corresponding entity classes:, (*4)
# app/config.yml
# ...
plehatron_limoncello:
schemas:
ApiBundle\Entity\Category: ApiBundle\Schema\CategorySchema
Create and register JSON API Controllers
API controllers should extend abstract \Plehatron\LimoncelloBundle\Controller\JsonApiController
class which has full JSON API support provided by the
neomerx/limoncello package., (*5)
See CategoryController file for an example on
how to write JSON API Controllers,, (*6)
Versioning
This bundle is following Semantic Versioning scheme., (*7)
Testing
Run tests with:, (*8)
$ vendor/bin/phpunit
Credits
This bundle is loosely based on elytus-limoncello-bundle., (*9)
License
Apache License (Version 2.0). Please see License File for more information., (*10)