m6web/fos-rest-extra-bundle

Extra feature for the FOSRestBundle

fos-rest-extra-bundle

Provide extra feature for the FOSRestBundle., _(*1)

Dependency

FOSRestExtraBundle requires FOSRestBundle., _(*2)

Installation

Add this line in your composer.json:, _(*3)

{
    "require": {
        "m6web/fos-rest-extra-bundle": "~1.0"
    }
}

Update your vendors:, _(*4)

$ composer update m6web/fos-rest-extra-bundle

Add to your AppKernel.php:, _(*5)

new FOS\RestBundle\FOSRestBundle(),
new M6Web\Bundle\FOSRestExtraBundle\M6WebFOSRestExtraBundle(),

Then modify the FOSRestBundle configuration of your application to add :, _(*6)

fost_rest:
    param_fetcher_listener: true

Configuration

m6_web_fos_rest_extra:
    param_fetcher:

        # Define if extra parameters are allowed. The behavior defined here is the default one and can
        # be overrided by a "RestrictExtraParam" annotation on the current action.
        # Optionnal, true by default
        allow_extra: true

        # Define if all parameters are strict. If true, all given parameters have to match defined
        # format for each on of them.
        # Optionnal, false by default
        strict: false

        # HTTP status code of throwed exception on query with invalid parameters
        # Optionnal, 400 by default
        error_status_code: 400

Usage

• RestrictExtraParam(true/false) Annotation : to allow (false) or forbid (true) unknown parameters, true by default.

use FOS\RestBundle\Controller\Annotations\QueryParam;
use M6Web\Bundle\FOSRestExtraBundle\Annotation\RestrictExtraParam;

/**
 * TestController
 */
class TestController
{
    /**
     * Restricted controller : only "param1" is permitted
     *
     * @return void
     *
     * @RestrictExtraParam(true)
     *
     * @QueryParam(name="param1", requirements="\d+", nullable=true, description="My Param 1")
     */
    public function getRestrictedAction() {

    }

    /**
     * Unrestricted controller : "param1" and unknown parameters are permitted
     * except if bundle configuration doesn't allow it
     *
     * @QueryParam(name="param1", requirements="\d+", nullable=true, description="My Param 1")
     *
     * @return void
     */
    public function getNonRestrictedAction() {

    }
}

Launch Tests

$ bin/atoum