pgdd/clintRest

EXPRESS API

Download

git clone https://github.com/pgdd/clintRest.git

Or download zip

Quick Start

Launch mongo first :

mongod

In a new shell :

npm install

npm test

npm start

API GUIDE

Marques

Routes

HTTP	routes	Result
GET	/api/marques	index marques
GET	/api/marques/:id	show marque
POST	/api/marques	create marque
PUT	/api/marques/:id	update marque
DELETE	/api/marques/:id	delete marque

####Content-Type application/json

Create and update a marque by sending JSON:

  {
    "name": "Peugeot"
  }

NB: We need to define at least the name.

Véhicules

Routes

HTTP	routes	Result
GET	/api/vehicules	index vehicules
GET	/api/vehicules/:id	show vehicule
POST	/api/vehicules	create vehicule
PUT	/api/vehicules/:id	update vehicule
DELETE	/api/vehicules/:id	delete vehicule

Content-Type application/json

Create a vehicule by sending JSON :

  {
    "name": "207",
    "marque": "Peugeot"
  }

Create a vehicule without defining a marque by sending JSON:

  {
    "name": "Clio"
  }

Update a vehicule to define it marque by sending JSON:

  {
    "marque": "Renault"
  }

This will push the ID of the targeted vehicule object into the appropriate marque object in the database.

NB: we need to define marque parameters with names of marques already registered in the database.

Special Query

Index vehicules by marque name

#####Route :

HTTP	routes	Result
GET	/api/vehicules/marque/:name	index vehicules by marque

#####Example :

curl http://localhost:3000/vehicules/marque/Peugeot

This will respond with a list of vehicules Peugeot. This list is populated from key "vehicules" of the Peugeot object.