Analyse technique apidb
L'API contient des points de terminaisons pour les utilisateurs et les voitures Les Points de terminaison suivant déclenchent des requêtes vers la base de données. Dans le cas d'un problème, L'API renvoie une erreur 400. Ci-dessus les différents points de terminaison
Tous les utilisateurs inscris ou non inscris pourra visualiser la liste de toutes les voitures disponibles dans la base de données.
Le point de terminaison suivant déclenche une requête allant chercher toutes les voitures dans la DB et sera utilisé lors du chargement de la page /cars.
Get /api/cars
| Name | Type | Dans | Description |
|---|---|---|---|
Frontend (@Axios)
Axios.get("https://localhost:3001/api/cars")
.then((res)=>{
console.log(res)
}).catch((err)=>{
console.err(err)
})Réponse
Status: 200 OK
{
"name" : "Audi RS3",
"price" : 500,
"brand": "Mercedes",
"model": "Class A",
"color": "Gray",
"doors": 4,
"boot_size": 150,
"type": "suv",
"energy": "essence",
"is_automatic": true,
"passengers": 5,
"air_conditioning" : true,
"description" : "exemple de description de voiture"
}Ressource introuvable
Status: 404 Not Found
Tous les utilisateurs inscris ou non inscris pourront filter les voitures sur base de la plage horaire de location.
Le point de terminaison suivant déclenche une requête allant chercher toutes les voitures dans la DB et sera utilisé lors du chargement de la page /cars.
Get /api/cars-slot?startDate="2022-04-12"&startHours="11:15"&endDate="2022-04-13"&endHours="12:20"
Frontend (@Axios)
Axios.get("https://localhost:3001/api/cars-slot")
.then((res)=>{
console.log(res)
}).catch((err)=>{
console.err(err)
})| Name | Type | Dans | Description |
|---|---|---|---|
accept |
string | headers |
Tous les utilisateurs inscris ou non inscris pourront filtrer les voitures sur base de la marque et du modèle de la voiture.
Le point de terminaison suivant déclenche une requête allant filtrer les voitures dans la DB sur base des critères reçus il sera utilisé lors dans la page /cars lorsque seul la marque et le modèle ont été ajuster par l'utilisateur au niveau du pannel des filtres dans la page /cars.
Get /api/cars-brand?brand="mercedes"&model="classe 1"
| Name | Type | Dans | Description |
|---|---|---|---|
accept |
string | headers |
Frontend (@Axios)
Axios.get("https://localhost:3001/api/cars/getBrandCars")
.then((res)=>{
console.log(res)
}).catch((err)=>{
console.err(err)
})Tous les utilisateurs inscris ou non inscris pourront filtrer les voitures sur base de la plage horaire de location en plus de la marque et du modèle.
Le point de terminaison suivant déclenche une requête filtrant les voitures dans la DB sur base des critères entré par l'utilisateur il sera utilisé lors du clique sur le bouton de filtre dans la page /cars (L'utilisateur ayant ajusté la marque, le modèle et la plage de location).
Get /api/cars-slot-brand?startDate="2022-04-12"&startHours="11:15"&endDate="2022-04-13"&endHours="12:20"&brand="mercedes"&model="classe 1"
| Name | Type | Dans | Description |
|---|---|---|---|
accept |
string | headers |
Frontend (@Axios)
Axios.get("https://localhost:3001/api/cars/getSlotBrandCars")
.then((res)=>{
console.log(res)
}).catch((err)=>{
console.err(err)
})L'insertion des voitures n'est effectué que par l'administrateur du site
Le point de terminaison suivant déclenche une requête inserant une voiture dans la DB et sera utilisé lors du clique sur le bouton de soumission du formulaire d'insertion dans la la page /addCars visible que par l'administrateur.
POST /api/car
| Name | Type | Dans | Description |
|---|---|---|---|
accept |
string | headers | Le type de contenu qu'accepte la requête Application/json |
name |
string | query | Nom descriptif du véhicule |
price |
float | query | obligatoire Prix de location par jour |
brand |
string | query | obligatoire Marque du véhicule |
model |
string | query | obligatoire Modèle du véhicule |
color |
string | query | obligatoire Coloration du véhicule |
doors |
integer | query | obligatoire Nombre de porte du véhicule |
boot_size |
integer | query | obligatoire La taille du coffre de la voiture en kg |
type |
string | query | obligatoire Ex : SUV, Electrique , etc.. |
energy |
string | query | obligatoire Le type d'energie que consomme le vehicule (Essence, diesel, ...) |
is_automatic |
boolean | query | obligatoire Permet de spécifier si la voiture est automatique ou manuel |
passengers |
integer | query | obligatoire Nombre de passager que peut supporter le véhicule |
air_conditionning |
boolean | query | obligatoire Spécifie si le véhicule est doté d'une air conditionné |
description |
string | query | Texte permettant de décrire brievement le véhicule a rajouter |
Frontend
axios.post('/api/car', data {
headers : { '
"Content-Type": 'Application/json'
}
})
.then((response)=> {
console.log(response);
})
.catch((error)=> {
console.log(error);
});Réponse
Status: 200 OK
Ressource introuvable
Status: 404 Not Found
L'insertion des images de véhicules n'est effectué que par l'administrateur du site
Le point de terminaison suivant déclenche une requête inserant des images de véhicules dans la table des images et sera utilisé lors du clique sur le bouton de soumission du formulaire d'insertion dans la la page /addCars visible que par l'administrateur.
POST /api/car-images/
| Name | Type | Dans | Description |
|---|---|---|---|
accept |
string | headers | Le type de contenu qu'accepte la requête multipart/form-Data |
name |
string | query | Nom descriptif du véhicule |
POST /api/cars/updateCars
| Name | Type | Dans | Description |
|---|---|---|---|
accept |
form | headers | Precision sur le type de contenu qu'accepte la requête |
Frontend
Axios.post("https://localhost:3001/api/cars/updateCars").then((res)=>{
//console.log(res)
}).catch((err)=>{
//console.err(err)
})Réponse
Lien vers la liste des endpoints documentés
- Justification du choix
- DB Relationnelle : Puisque les données doivent être ordonnées et structurées et que des relations doivent exister entre les différentes données, il est essentiel d’utiliser une base de données SQL afin de garantir l’organisation de ces dernières.
Ainsi nous avons dû choisir entre MySQL et PostgreSQL, ce sont les deux BDD relationnelles les plus utilisées, nous avons fini par choisir PostgreSQL pour les raisons suivantes:
- Type de données avancé : PostgreSQL supporte les types MySQL et ajoute des types plus avancés tels que JSON, Array, ... Alors que pour avoir une relation 1-N, on devrait normalement créer une table supplémentaire.
- Réplication : PostgreSQL permet d'avoir 2 ou plusieurs bases de données répliquées, pour avoir le Load-Balancing et la redondance.
- Performance en concurrence: PostgreSQL est optimisée pour les requêtes parallèles, notamment la lecture par index. Étant donné que sur une application web on aurait des connexions simultanées pour chaque utilisateur, cette optimisation est nécessaire.
- Légèreté & performance : une base de données légère convient plus à notre hébergement client et mutualisé. PostgreSQL est moins vorace que ses concurrents, tant pour la RAM que pour le CPU. Malgré sa faible consommation de RAM, il demeure très performant par rapport à MySQL. Source
- Odoo l'utilise ;)
PostgreSQL jouit d’une solide réputation en matière de fiabilité, de robustesse des fonctionnalités et des performances.
Schéma de notre base de données :
- Diagrammes
[Schémas EA / Relationnel de la DB] [Texte expliquant les diagrammes et justifiant les choix de conception]