obtao/symfony-rest-api-framework

A Rest API distribution of the Symfony framework

v0.1.0 2015-01-27 18:59 UTC

Requires

• php: >=5.3.3
• doctrine/doctrine-bundle: ~1.2
• doctrine/orm: ~2.2,>=2.2.3
• friendsofsymfony/rest-bundle: ~1.4
• incenteev/composer-parameter-handler: ~2.0
• jms/serializer-bundle: ~0.13
• nelmio/api-doc-bundle: ~2.7
• sensio/distribution-bundle: ~3.0,>=3.0.12
• sensio/framework-extra-bundle: ~3.0
• symfony/monolog-bundle: ~2.4
• symfony/symfony: ~2.6

Requires (Dev)

• sensio/generator-bundle: ~2.3

MIT

README

About

This projet is a Symfony Distribution to build fast Rest API. This uses the following components :

• Symfony
• FOS REST Bundle
• JMS Serializer
• Nelmio Api Doc Bundle

Requirements

As it uses the Symfony full-stack framework, this framework is only supported on PHP 5.3.9 and up.

Be warned that PHP 5.3.16 has a major bug in the Reflection subsystem and is not suitable to run Symfony (https://bugs.php.net/bug.php?id=62715)

Installation

Get the sources from Github with Composer

composer create-project obtao/symfony-rest-api-framework yourProjectPath

Install the project as a classic Symfony projet (see the documentation)

Test the API example :

/app_dev.php/api/blob should display a datetime

/app_dev.php/ should display the API documentation

Now you're done. Remove the Blob entity and the getBlobAction. Then, start to code in the ApiController.