Crous Api

Cette API a été conçue lors d'un semestre d'études au CEGEP de Matane suite à un échange avec l'IUT de Laval, France.
Elle permet la récupération de toutes les données fournies par l'État français et liées aux CROUS.
Les données suivantes sont ainsi accessibles :

Les Restaurants et leurs menus (si communiqué)
Les Résidences
Les Actualités

Les structures de données sont disponibles dans la documention fournie, soit via l'url suivante, soit via l'endpoint /docs une fois l'API fonctionnelle

⚠ Les données de base étant stockées dans un fichier XML et contenant des balises HTML, certains type de données ne sont pas entièrement exploitables (Résidences et Actualités)

Installation

npm install

Utilisation

En tant que serveur web

npm run start

En tant que module

import express from "express";
import setupRouter from "./router.js";

const app = express();
const crousRouter = setupRouter(socketIoNamespace);
app.use("myPath", crousRouter);
app.listen(process.env.PORT ?? 8080);

L'API prenant quelques secondes à s'initialiser, toute requête réalisée avant la fin de ce processus amènera la réponse suivante
425 - Api Starting, please wait...

Auteur

👤 Le_Roux-Nard

Github: @le-roux-nard