API Project

Description

Ce projet est une API RESTful qui permet la gestion des utilisateurs, des CVs et des recommandations.

Table des matières

1. Prérequis
2. Installation
3. Variables d'environnement
4. Lancement du projet
5. Endpoints de l'API
   • Auth
   • CV
   • Recommendations

Prérequis

• Node.js
• MongoDB
• Un gestionnaire de paquets : npm ou yarn

Installation

Clonez le projet : git clone https://github.com/GitJaack/Cv_Generator

Variables d'environnement

Créez un fichier .env à la racine du projet avec les variables d'environnement suivantes : PORT=3001 DATABASE_URL=mongodb://localhost:27017/myDB JWT_SECRET=yourSecretKeyHere

Lancement du projet

npm start

Endpoints de l'API

Auth

Méthode | Endpoint | Description | Body Params Post | api/register | Inscription d'un utilisateur | { email, password } Post | api/login |Connexion d'un utilisateur | { email, password }

CV

Méthode | Endpoint | Description | Body Params GET | cvRouter/ | Obtenir tous les CV | POST |cvRouter/create|Créer un nouveau CV | { firstName, lastName, description, ... } GET |/cvRouter/:id |Récupérer les détails d'un CV par ID PUT |/cvRouter/:id |Mettre à jour son CV existant { firstName, lastName, description, ... } DELETE |/cvRouter/:id |Supprimer un CV

Recommendations

Méthode | Endpoint | Description | Body Params POST |/cvRouter/:id/recommendation | Ajouter une recommandation à un CV | {content} GET |/cvRouter/:id/recommendations Récupérer toutes les recommandations pour un CV