staegi/symfony-rest-api

The "Symfony2 REST API " project

REST API based on Symfony 2

, _(*1)

This is a nice start point to create an application which provides a REST interface to your database., _(*2)

Requirements

• git
• MySQL
• PHP 5.4 or higher
• Apache 2 or Nginx
• Composer

Installation

Create project with vendors:, _(*3)

curl -sS https://getcomposer.org/installer | php
composer.phar create-project staegi/symfony-rest-api
cd symfony-rest-api

Create development database:, _(*4)

php bin/console doctrine:database:create -e dev
php bin/console doctrine:schema:create -e dev

Load fixtures to create first client and user:, _(*5)

php bin/console doctrine:fixtures:load

Preconfigured vendor modules

• FOSOAuthServerBundle: Provides token and user authorization with OAuth2
• FOSUserBundle: Provides user and group management
• FOSRestBundle: Provides various tools to rapidly develop RESTful API's with Symfony
• NelmioApiDocBundle: Generates documentation for your REST API from annotations
• NelmioCorsBundle: Adds CORS (Cross-Origin Resource Sharing) headers support in your Symfony2 application
• JMSSerializerBundle: Allows you to easily serialize, and deserialize data of any complexity
• LiipMonitorBundle: Provides an interface for monitoring
• DoctrineBundle: Provides an ORM database layer
• DoctrineFixturesBundle: Provides fixtures to load data for initial installation and acceptance tests

Documenttation

The API documentation is shown under api.your-domain.com/doc., _(*6)

Monitoring

The monitoring is running under api.your-domain.com/monitor/, _(*7)

Unit tests

Create test database:, _(*8)

php bin/console doctrine:database:create -e test

Run the unit tests with:, _(*9)

bin/phpunit

For the acceptance test you need a test database. Set test_database_name, test_database_user and test_database_password in your parameters.yml., _(*10)