paul-schuhm / badminton_api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API de Réservation de Terrains de Badminton

Table des matières

Lancer le projet

Pour lancer le projet, suivre les étapes suivantes :

cd api
npm install
npm run swagger-autogen
node app.js

L'API est exposée sur l'URL http://localhost:3000

Tester l'API :

curl http://localhost:3000

Conception

Dictionnaire des données

Ressource URL Méthodes HTTP Paramètres d’URL/Variations Commentaires
Adhérents /adherents GET disponible (true ou false), pseudo Récupère la liste des adhérents
Adhérent /adherents/:id GET - Récupère un adhérent par son identifiant
Réservations /admin/reservations GET - Récupère la liste des réservations (admin uniquement)
Terrains /admin/terrains GET - Récupère la liste des terrains (admin uniquement)
Terrain /admin/terrains/:name/disponible POST - Modifie la disponibilité d'un terrain (admin uniquement)

Modèle Conceptuel des Données (MCD)

MCD

Remarques

  • Les adhérents peuvent consulter la liste des réservations et leur propre profil.
  • Les admins peuvent consulter la liste des réservations, la liste des terrains et modifier la disponibilité d'un terrain.
  • L'authentification est requise pour accéder aux ressources réservées aux admins.

Références

Code source

Le code source de l'API est disponible sur GitHub.

About


Languages

Language:JavaScript 98.3%Language:Pug 1.4%Language:CSS 0.3%