restaurant-api

0.0.0 • Public • Published

Commande pour lancer l'API (dans le répertoire ./test_api) : docker-compose up --build

Normalement avec cela l'API tourne sur le port 3001

Voici un liste des reqûetes possibles :

Créer une tâche (Create)
    Méthode HTTP : POST
    Endpoint : /tasks
    Corps de la requête : JSON avec les données de la tâche à créer (title, description, completed)

Récupérer toutes les tâches (Read)
    Méthode HTTP : GET
    Endpoint : /tasks

Récupérer une seule tâche par son ID (Read)
    Méthode HTTP : GET
    Endpoint : /tasks/:id
    Paramètres de la requête : ID de la tâche à récupérer

Mettre à jour une tâche par son ID (Update)
    Méthode HTTP : PUT
    Endpoint : /tasks/:id
    Paramètres de la requête : ID de la tâche à mettre à jour
    Corps de la requête : JSON avec les données mises à jour de la tâche (title, description, completed)

Supprimer une tâche par son ID (Delete)
    Méthode HTTP : DELETE
    Endpoint : /tasks/:id
    Paramètres de la requête : ID de la tâche à supprimer

Voici un liste des reqûetes possibles :

Créer un utilisateur (Create)
    Méthode HTTP : POST
    Endpoint : /users
    Corps de la requête : JSON avec les données de l'utilisateur à créer (email, password, firstName, lastName, dob, phone)

Récupérer toutes les utilisateurs (Read)
    Méthode HTTP : GET
    Endpoint : /users

Récupérer une seule tâche par son email (Read)
    Méthode HTTP : GET
    Endpoint : /users/:email
    Paramètres de la requête : email de l'utilisateur à récupérer

Mettre à jour un utilisateur par son email (Update)
    Méthode HTTP : PUT
    Endpoint : /users/:email
    Paramètres de la requête : email de l'utilisateur à mettre à jour
    Corps de la requête : JSON avec les données mises à jour de l'utilisateur (email, password, firstName, lastName, dob, phone )

Supprimer un utilisateur par son ID (Delete)
    Méthode HTTP : DELETE
    Endpoint : /users/:email
    Paramètres de la requête : ID de la tâche à supprimer

Readme

Keywords

none

Package Sidebar

Install

npm i restaurant-api

Weekly Downloads

0

Version

0.0.0

License

none

Unpacked Size

33.7 kB

Total Files

14

Last publish

Collaborators

  • tigrou02