Spaces:
Sleeping
Sleeping
refactor: update API documentation and endpoints for clarity and accuracy
Browse files
app.py
CHANGED
|
@@ -12,33 +12,40 @@ Bienvenue sur l'API de Getaround pour prédire le prix journalier de location d'
|
|
| 12 |
Pour tester le fonctionnement de l'API, vous pouvez utiliser le point de terminaison d'introduction suivant:
|
| 13 |
* `/`: **GET** retourne la version de l'API et un message de bienvenue.
|
| 14 |
|
| 15 |
-
## Point de terminaison
|
| 16 |
|
| 17 |
-
Cette API permet de prédire le prix journalier de location d'une voiture.
|
| 18 |
-
* `/price/{car_id}`: **GET** retourne le prix journalier de location d'une voiture en fonction de son identifiant.
|
| 19 |
|
|
|
|
|
|
|
| 20 |
|
| 21 |
-
|
|
|
|
| 22 |
|
| 23 |
Cette terminaison de l'API permet de prédire le prix journalier de location d'une voiture en fonction de ses caractéristiques..
|
| 24 |
|
| 25 |
-
* `/predict` accepte une requête POST avec un JSON contenant
|
|
|
|
| 26 |
|
| 27 |
|
| 28 |
-
|
| 29 |
"""
|
|
|
|
| 30 |
tags_metadata = [
|
| 31 |
{
|
| 32 |
"name": "Point de terminaison d'introduction",
|
| 33 |
-
"description": "Terminaison simple de
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
},
|
| 35 |
{
|
| 36 |
-
"name": "
|
| 37 |
-
"description": "Point de terminaison
|
| 38 |
},
|
| 39 |
{
|
| 40 |
"name": "Machine Learning",
|
| 41 |
-
"description": "
|
| 42 |
},
|
| 43 |
]
|
| 44 |
app = FastAPI(
|
|
|
|
| 12 |
Pour tester le fonctionnement de l'API, vous pouvez utiliser le point de terminaison d'introduction suivant:
|
| 13 |
* `/`: **GET** retourne la version de l'API et un message de bienvenue.
|
| 14 |
|
| 15 |
+
## Point de terminaison de ligne de vie
|
| 16 |
|
|
|
|
|
|
|
| 17 |
|
| 18 |
+
Cette web fonction permet de vérifier que le serveur de l'API est opérationnel et de surveiller son statut.
|
| 19 |
+
* `/health`: **GET** retourne juste OK pour valider que le serveur de l'API est en cours d'exécution sans problèmes.
|
| 20 |
|
| 21 |
+
|
| 22 |
+
## Machine Learning : Point de terminaison du prix de location
|
| 23 |
|
| 24 |
Cette terminaison de l'API permet de prédire le prix journalier de location d'une voiture en fonction de ses caractéristiques..
|
| 25 |
|
| 26 |
+
* `/predict` accepte une requête POST avec un JSON contenant un objet JSON donnant les caractéristiques d'une voiture
|
| 27 |
+
et retourne une prédiction du prix journalier de location de celle-ci.
|
| 28 |
|
| 29 |
|
| 30 |
+
La documentation est ci-dessous 👇 pour chaque point de terminaison (endpoints).
|
| 31 |
"""
|
| 32 |
+
Point de terminaison de ligne de vie
|
| 33 |
tags_metadata = [
|
| 34 |
{
|
| 35 |
"name": "Point de terminaison d'introduction",
|
| 36 |
+
"description": "Terminaison simple de présentation de l'API et de sa version pour vérifier que tout fonctionne correctement.",
|
| 37 |
+
},
|
| 38 |
+
{
|
| 39 |
+
"name": "Point de terminaison de ligne de vie",
|
| 40 |
+
"description": "Point de terminaison de ligne de vie pour surveiller le statut du serveur de l'API. Retourne 'ok' si le serveur fonctionne sans problèmes.",
|
| 41 |
},
|
| 42 |
{
|
| 43 |
+
"name": "Point de terminaison du prix de location",
|
| 44 |
+
"description": "Point de terminaison permettant de prédire le prix journalier de location d'une voiture en fonction de ses caractéristiques.",
|
| 45 |
},
|
| 46 |
{
|
| 47 |
"name": "Machine Learning",
|
| 48 |
+
"description": "Point de terminaison de prediction du prix de location journalier d'un véhicule en fonction de ses caractéristiques.",
|
| 49 |
},
|
| 50 |
]
|
| 51 |
app = FastAPI(
|