API: Liste de restaurants favoris

GET /favorites

Retourne les listes de restaurants favoris de tous les utilisateurs.

Entrée

Token d'authentification nécessaire

Paramètres facultatifs

limit donne le nombre de résultats maximums voulu. (Valeur par défault de 10) Ex: /favorites?limit=20.

page représente la page demandée. (Valeur par défault de 0) Ex: /favorites?page=1.

Sortie

Retourne une liste de restaurants favoris

[
    "items": {
        "restaurants": [],
        "owner": {
            "email": "[email protected]",
            "name": "username",
            "id": "5678"
        },
        "name": "My super favorite list",
        "id": "1234"
        }, {
        ...
        }
    },
    "total": 2
]

GET /favorites/:id

Permet d'afficher la liste de restaurants favoris correspondant à l'id demandé.

Entrée

Token d'authentification nécessaire

Aucun paramètres

Sortie

Exemple:

{
    "restaurants": [],
    "owner": {
        "email": "[email protected]",
        "name": "username",
        "id": "5678"
    },
    "name": "My super favorite list",
    "id": "1234"
}

POST /favorites

Permet de créer une nouvelle liste de restaurants favoris.

Entrée

Token d'authentification nécessaire

** Paramètres d'entrée **

owner est seulement nécessaire pour utilisation sans token

{
  "name": "My super favorite list",
  "owner": "[email protected]" 
}

Sortie

Exemple:

{
    "name": "My super favorite list",
    "restaurants": [],
    "id": "12345"
}

PUT /favorites/:id

Permet de modifier la liste de restaurants favoris correspondant à l'id demandé.

Entrée

Token d'authentification nécessaire

** Paramètres d'entrée **

owner est seulement nécessaire pour utilisation sans token

{
  "name": "My super favorite list",
  "owner": "[email protected]" 
}

Sortie

Exemple:

{
    "name": "My super favorite list",
    "restaurants": [],
    "id": "12345"
}

DELETE /favorites/:id

Permet de supprimer la liste de restaurants favoris correspondants à l'id demandé.

Entrée

Token d'authentification nécessaire

** Paramètres d'entrée ** AUCUN

Sortie

Exemple:

{
    "message": "Favorite list deleted successfully"
}

POST /favorites/:id/restaurants

Permet d'ajouter un restaurant la liste de favoris correspondant à l'id demandé.

Entrée

Token d'authentification nécessaire

** Paramètres d'entrée **

{
    "id": 12345
}

Sortie

Exemple:

La liste de favoris contiendra le restaurant dans la liste restaurants.

{
    "name": "My super favorite list",
    "restaurants": [],
    "id": "12345"
}

DELETE /favorites/:id/restaurants/:restaurantId

Permet de retirer le restaurant avec l'id restaurantId de la liste de favoris correspondant à l'id id demandé.

Entrée

Token d'authentification nécessaire

** Aucun paramètres **

Sortie

Exemple:

La liste de favoris ne contient plus le restaurant correspondant à l'id restaurantId dans la liste restaurants.

{
    "name": "My super favorite list",
    "restaurants": [],
    "id": "12345"
}