API - procédure d'installation simple (sans Docker)

Prérequis :

NodeJS
Npm

Installation :

git clone https://github.com/MarieLBernard44/just_api.git
cd just_api
npm i

Mise en place de la base de données: Importer le fichier dump.sql dans votre Système de Gestion de Base de Données MySQL

Démarrage :

npm start

Accès à l'API sur l'url : http://localhost:3000

Application conteneurisée avec docker - procédure d'installation

Prérequis :

docker
docker-compose

Clonage du repository

git clone https://github.com/MarieLBernard44/just_api.git
cd just_api
npm i

Configuration de la base de données (db-config.js)

  ...
  host     : 'database',
  ...
});

Copier le fichier dump.sql fourni par e-mail, dans le répertoire just_api/docker-config/DB. Ce dossier est destiné aux futures migrations de la base de données.

Le port ouvert sur la machine hôte est le port 3000 et le port du serveur node JS exposé sur le conteneur est le 3000

docker-compose build

Lancement de l'application en mode démon

docker-compose up  -d

Accès via le navigateur

Accès à l'API sur l'url : http://localhost:3000/

Urls de l'API

Ci dessous, les routes de l’application web :

VERBES	URL	ACTION
GET	/	Affiche l’interface de l’application web.
POST	/	Génère le token d’authentification et créé un cookie pour le contenir.
POST	/download/:activity	Permet de télécharger une liste de profils par activité.

Ci dessous, les url utilisées par notre API

VERBES	URL	ACTION
GET	/api/v1	Renvoie l’ensemble des profils.
GET	/api/v1/:activity	Renvoie les profils filtrés par secteur d’activité.
POST	/api/v1/authenticate	Génère le token d’authentification si le nom d’utilisateur et le mot de passe renseignés sont valides.

Déploiement

Pour protéger l'application des attaques cross-domain type CSRF (Cross-Site Request Forgery), il est nécessaire de renseigner le paramètre Access-Control-Allow-Origin dans les headers de la requête HTTP (fichier app.js). Pour des raisons de sécurité, évitez d'utiliser le wildcard * et renseignez le nom de domaine de votre site.