Santiago Diaz sdiaz

Basic RESTful API with Symfony 2 + FOSRestBundle (JSON format only) + FOSUserBundle + FOSOauthServerBundle

The API we are creating in this gist will follow these rules :

The API only returns JSON responses
All API routes require authentication
Authentication is handled via OAuth2 with password Grant Type only (no need for Authorization pages and such).
API versioning is managed via a subdomain (e.g. v1.api.example.com)

The API will be written in PHP with the Symfony 2 framework. The following SF2 bundles are used :

I have managed to install this… and make it work. I implemented it for Facebook and Google, but you can extend it. My solution it is mostly as described in #116, with a bit of more code presented. The key aspects that lack in the #116 presentation (IMO) are:

the registration as service of your custom FOSUBUserProvider (with the necessary parameters)
set the service for oauth_user_provider in the security.yml with your custom created service

Here are the steps:

Routing. In routing.yml I have added all the routes for both bundles.
Configuration. I have set the config.yml mostly as it is presented in the HWIOAuthBundle.
Security. I have set the security.yml mostly as it is presented in the HWIOAuthBundle (though my routes are using /login pattern, not /connect). Also, the oauth_user_provider is set for my custom service.

It's still a work in progress...

Intro

As William Durand was recently explaining in his SOS, he "didn't see any other interesting blog post about REST with Symfony recently unfortunately". After spending some long hours to implement an API strongly secured with oAuth, I thought it was time for me to purpose my simple explanation of how to do it.

Ok, you know the bundles

You might have already seen some good explanation of how to easily create a REST API with Symfony2. There are famous really good bundles a.k.a. :

	[PHP]

	;;;;;;;;;;;;;;;;;;;;
	; Language Options ;
	;;;;;;;;;;;;;;;;;;;;

	engine = On
	short_open_tag = Off
	asp_tags = Off
	precision = 14