emmanuel-ba/aramis

Welcome to Aramis Rest API

What's inside ?

A REST API developed using Symfony 3.1 , FosRestBundle and JMSSerializerBundle. The purpose is to handle a basic list of cars., _(*1)

Installation

Make sure MySQL and PHP >=5.5.9 are installed., _(*2)

1. Choose your favorite way to get composer., _(*3)

2. Install project :, _(*4)

   php composer.phar create-project emmanuel-ba/aramis aramis -sdev, _(*5)

   database credentials should be asked during installation, _(*6)

3. Create database:, _(*7)

   cd aramis, _(*8)

   php bin/console doctrine:database:create, _(*9)

   php bin/console doctrine:schema:update --force, _(*10)

   you can alternatively use the mysql dump file provided (aramis.sql)., _(*11)

4. Load fixtures :, _(*12)

   php bin/console doctrine:fixtures:load, _(*13)

5. Launch tests with phpunit:, _(*14)

   phpunit, _(*15)

6. Start PHP's built-in web server using Symfony Command :, _(*16)

   php bin/console server:run, _(*17)

   Api should be available at http:localhost:8000, _(*18)

Test API

Quick tests using Postman

You need to have postman installed. Have a look at the Chrome extension, _(*19)

1. Load the provided environment and collection in postman :
   • environment : Aramis.postman_collection.json
   • collection : TEST.postman_environment.json

Run the tests on the collection, _(*20)

There should be 22 tests passed, _(*21)

Manual tests using curl

• GET cars (response code 200 expected)

> curl -X GET -H "Cache-Control: no-cache" "http://localhost:8000/cars", _(*22)

• GET car (response code 200 expected)

> curl -X GET -H "Cache-Control: no-cache" "http://localhost:8000/car/1", _(*23)

• POST car (response code 201 expected)

curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "maker" : "Seat", "model" : "Leon", "price" : 15000, "option" : [{"name" : "Spoiler"}, {"name" : "GPS"}], "equipment" : [{"name" : "ABS"}, {"name" : "Turbo"}] } }' "http://localhost:8000/car", _(*24)

• INVALID POST car (response code 400 expected)

> curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "model" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "price" : 15000, "option" : [{"name" : "Spoiler"}, {"name" : "GPS"}], "equipment" : [{"name" : "ABS"}, {"name" : "Turbo"}] } }' "http://localhost:8000/car", _(*25)

• PUT car (response code 204 expected)

> curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "maker" : "Audi", "model" : "Q7", "price" : 75000, "option" : [{"name" : "Camera recul"}, {"name" : "Pack cuir"}], "equipment" : [{"name" : "Boite auto"}, {"name" : "Climatisation"}] } }' "http://localhost:8000/car/3", _(*26)

• INVALID put car (response code 400 expected)

> curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "maker" : "Audi", "model" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "price" : 75000, "option" : [{"name" : "Camera recul"}, {"name" : "Pack cuir"}], "equipment" : [{"name" : "Boite auto"}, {"name" : "Climatisation"}] } }' "http://localhost:8000/car/3", _(*27)

• PATCH car (response code 204 expected)

> curl -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "model" : "Q5" } }' "http://localhost:8000/car/3", _(*28)

INVALID PATCH : (response code 400 expected), _(*29)

> curl -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"car" : { "model" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx" } }' "http://localhost:8000/car/3", _(*30)

DELETE a car : (response code 204 expected), _(*31)

curl -X DELETE -H "Cache-Control: no-cache" "http://localhost:8000/car/3", _(*32)