setup.md

Setting up the bundle

A: Install Ecentria Generic Service Bundle

Add the repository to your composer.json file

"repositories": [
    ...
    { "type": "vcs", "url": "https://github.com/ecentria/EcentriaRestBundle" }
]

Add via composer command

$ php composer.phar require ecentria/ecentria-rest-bundle dev-master

Or Add via composer.json directly

"ecentria/ecentria-rest-bundle": "dev-master"

B: Enable the bundle

Enable the bundle, as well as the FOSRestBundle and JMSSerializerBundle in the kernal:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
         new Ecentria\Libraries\EcentriaRestBundle\EcentriaRestBundle(),
         new FOS\RestBundle\FOSRestBundle(),
         new JMS\SerializerBundle\JMSSerializerBundle(),
         new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
    );
}

C: Update app/config/config.yml

Modify app/config/config.yml and add the following:

sensio_framework_extra:
    view:
        annotations: false

fos_rest:
    param_fetcher_listener: true
    body_listener: true
    format_listener: true
    routing_loader:
            default_format: json
    view:
        view_response_listener: 'force'

nelmio_api_doc: ~

If you want use native json_encode/decode in your project instead of JMS\Serializer, add one more option to the end of fos_rest section:

fos_rest:
    ...
    service:
        serializer: ecentria.fos_rest.native_json_encode_serializer

D: Update app/config/routing.yml

Modify app/config/routing.yml and add the following:

_ecentria_rest_bundle:
    resource: "@EcentriaRestBundle/Resources/config/routing.yml"

NelmioApiDocBundle:
    resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
    prefix:   /api/doc

E: (Optional) Setup multiple entity managers

It's a specific way of setting up the EM (entity manager) so that the EcentriaRestBundle can intelligently handle them. The entity manager is automatically determined based upon the location of an entity. The prefix and dir config options below are very important in determining the EM associated with the entity.

Update your app/config/config.yml with something similar to the example below:

entity_managers:
    default:
        connection: default
        mappings:
            BookSellingBundle:
                type: annotation
                prefix: BookSellingBundle\Entity\Library
                dir:  Entity/Library
            EcentriaRestBundle: # we want to use this EM for transactions
                type: annotation
                dir:  Entity/

    other:
        connection: other
        mappings:
            BookSellingBundle:
                type: annotation
                prefix: BookSellingBundle\Entity\Customer
                dir:  Entity/Customer