Getting Started With FOSRestBundle¶

Installation¶

Installation is a quick (I promise!) one-step process:

Setting up the bundle

Bundle usage¶

Before you start using the bundle it is advised you run a quick look over the listed sections below. This bundle contains many features that are loosely coupled so you may or may not need to use all of them. This bundle is just a tool to help you in the job of creating a REST API with Symfony.

FOSRestBundle provides several tools to assist in building REST applications:

Config reference¶

Run bin/console config:dump-reference fos_rest for a reference of the available configuration options
Annotations reference for a reference on the available configurations through annotations

Example applications¶

The following bundles/applications use the FOSRestBundle and can be used as a guideline:

The FOSCommentBundle uses FOSRestBundle for its API.
The Symfony2 Rest Edition provides a complete example of how to build a controller that works for both HTML as well as JSON/XML.