Ian Rodrigues ianrodrigues

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. :

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 :

	{
	"estados": [
	{
	"sigla": "AC",
	"nome": "Acre",
	"cidades": [
	"Acrelândia",
	"Assis Brasil",
	"Brasiléia",
	"Bujari",

	<?php

	use Symfony\CS\Config\Config;
	use Symfony\CS\FixerInterface;
	use Symfony\CS\Finder\DefaultFinder;

	$fixers = [
	'blankline_after_open_tag',
	'braces',
	'double_arrow_multiline_whitespaces',

	server {
	listen 80;

	root /var/www/YOUR_DIRECTORY;
	index index.php index.html index.htm;

	###################################################
	# Change "yoururl.com" to your host name

	server_name yoururl.com;

	# Image neeeds to have ssh-client
	image: docker:git

	services:
	- docker:dind

	stages:
	- staging
	before_script:
	- docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY

	<?php
	/**
	* Gera a paginação dos itens de um array ou collection.
	*
	* @param array\|Collection $items
	* @param int $perPage
	* @param int $page
	* @param array $options
	*
	* @return LengthAwarePaginator

	.video-container {
	position: relative;
	padding-bottom: 56.25%; /16:9/
	padding-top: 30px;
	height: 0;
	overflow: hidden;
	}

	.video-container iframe,
	.video-container object,

	mutation updateUser(
	details: UpdateUserInput!
	): UpdateUserResult

	union UpdateUserResult =
	UpdateUserSuccess \|
	FormValidationError

	type UpdateUserSuccess {}