Warning: You are browsing the documentation for version 2.7 which is not maintained anymore.

If some of your projects are still using this version, consider upgrading.

Step 1: Setting up the bundle

2.7 version
Maintained Unmaintained

Step 1: Setting up the bundle

A) Download the Bundle

Assuming you already have set up a Symfony project, you can add the FOSRestBundle to it. Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require friendsofsymfony/rest-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.


If you are not using Flex, you also have to enable the bundle by adding the following line in the app/AppKernel.php:

// app/AppKernel.php
class AppKernel extends Kernel
    public function registerBundles()
        $bundles = [
            // ...
            new FOS\RestBundle\FOSRestBundle(),

        // ...

B) Enable a Serializer

This bundle needs a serializer to work correctly. In most cases, you’ll need to enable a serializer or install one. This bundle tries the following (in the given order) to determine the serializer to use:

  1. The one you configured using fos_rest.service.serializer (if you did).
  2. The JMS serializer, if the JMSSerializerBundle is available (and registered).
  3. The Symfony Serializer if it’s enabled (or any service called serializer).

That was it!

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.