How to create a Symfony Rest API from scratch
Initialize the project
|
1 2 |
composer create-project symfony/framework-standard-edition symfony-rest "3.0.*" cd symfony-rest |
Install dependencies
|
1 2 3 |
composer require friendsofsymfony/rest-bundle composer require jms/serializer-bundle composer require nelmio/cors-bundle |
FosRestBundle
Is the base for our REST API, it will manage client request to answer the right response (Exemple : JSON or XML)
JMSSerializerBundle
This is the bundle that handles the actual serialization of our objects, arrays and values.
NelmioCorsBundle
CORS are some headers that our server will output in order to allow a different domain to call our API.
Register bundles
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// app/AppKernel.php public function registerBundles() { $bundles = [ // ... new FOS\RestBundle\FOSRestBundle(), new JMS\SerializerBundle\JMSSerializerBundle(), new Nelmio\CorsBundle\NelmioCorsBundle(), // ... new AppBundle\AppBundle() ]; } |
Configure bundles
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
# app/config/config.yml # Nelmio CORS Configuration nelmio_cors: defaults: allow_credentials: false allow_origin: ['*'] allow_headers: ['*'] allow_methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'] max_age: 3600 hosts: [] origin_regex: false # FOSRest Configuration fos_rest: body_listener: true format_listener: rules: - { path: '^/', priorities: ['json'], fallback_format: json, prefer_extension: false } param_fetcher_listener: true view: view_response_listener: 'force' formats: json: true |
Ok now let’s code on the next page
Comments (10)