Dans un BTS CIEL ou SIO, tu vas tr\u00e8s souvent d\u00e9velopper ou interfacer des services web. Aujourd\u2019hui, presque toutes les applications communiquent gr\u00e2ce \u00e0 des API REST. Un serveur web, une application mobile, un outil de supervision ou un portail m\u00e9tier utilisent g\u00e9n\u00e9ralement des \u00e9changes HTTP au format JSON.<\/p>\n\n\n\n
Flask permet de cr\u00e9er rapidement une API en Python avec une structure simple et p\u00e9dagogique. Tu peux ainsi comprendre facilement le fonctionnement des routes HTTP, des r\u00e9ponses JSON, des m\u00e9thodes GET\/POST et des codes de retour.<\/p>\n\n\n\n
Dans cette fiche, tu vas apprendre \u00e0 :<\/p>\n\n\n\n
curl<\/code>.<\/li>\n<\/ul>\n\n\n\nCette fiche utilise principalement Debian et Ubuntu.<\/p>\n\n\n\n
2. Sommaire<\/h2>\n\n\n\n\n- Introduction<\/li>\n\n\n\n
- Sommaire<\/li>\n\n\n\n
- Comprendre le fonctionnement d\u2019une API Flask<\/li>\n\n\n\n
- Installer Flask sur Debian et Ubuntu<\/li>\n\n\n\n
- Arborescence recommand\u00e9e du projet<\/li>\n\n\n\n
- Synth\u00e8se Markdown pour ta fiche bristol<\/li>\n\n\n\n
- Fichiers importants<\/li>\n\n\n\n
- Configuration compl\u00e8te d\u2019une API Flask<\/li>\n\n\n\n
- Comprendre le code Flask en d\u00e9tail<\/li>\n\n\n\n
- Tester l\u2019API<\/li>\n\n\n\n
- G\u00e9rer les m\u00e9thodes HTTP<\/li>\n\n\n\n
- Utiliser des param\u00e8tres et du JSON<\/li>\n\n\n\n
- S\u00e9curiser une API Flask<\/li>\n\n\n\n
- Configurer le pare-feu UFW<\/li>\n\n\n\n
- Superviser et analyser les logs<\/li>\n\n\n\n
- Commandes utiles et d\u00e9pannage<\/li>\n\n\n\n
- Cas concrets d\u2019utilisation<\/li>\n\n\n\n
- Erreurs fr\u00e9quentes<\/li>\n\n\n\n
- Bonnes pratiques<\/li>\n\n\n\n
- Pour aller plus loin<\/li>\n\n\n\n
- Liens utiles et documentation officielle<\/li>\n\n\n\n
- Propositions de TP<\/li>\n<\/ol>\n\n\n\n
3. Comprendre le fonctionnement d\u2019une API Flask<\/h2>\n\n\n\n
Une API REST fonctionne gr\u00e2ce au protocole HTTP.<\/p>\n\n\n\n
Le client envoie une requ\u00eate :<\/p>\n\n\n\n
\n- GET \u2192 lire des donn\u00e9es ;<\/li>\n\n\n\n
- POST \u2192 ajouter des donn\u00e9es ;<\/li>\n\n\n\n
- PUT \u2192 modifier ;<\/li>\n\n\n\n
- DELETE \u2192 supprimer.<\/li>\n<\/ul>\n\n\n\n
Le serveur Flask r\u00e9pond g\u00e9n\u00e9ralement au format JSON.<\/p>\n\n\n\n
Exemple :<\/p>\n\n\n\n
Client :<\/p>\n\n\n\n
GET \/api\/status HTTP\/1.1<\/code><\/pre>\n\n\n\nR\u00e9ponse :<\/p>\n\n\n\n
{
\"status\": \"ok\"
}<\/code><\/pre>\n\n\n\nFlask agit comme un micro-framework web Python. Il fournit :<\/p>\n\n\n\n
\n- un serveur HTTP ;<\/li>\n\n\n\n
- un syst\u00e8me de routes ;<\/li>\n\n\n\n
- la gestion des requ\u00eates ;<\/li>\n\n\n\n
- la gestion des r\u00e9ponses JSON.<\/li>\n<\/ul>\n\n\n\n
4. Installer Flask sur Debian et Ubuntu<\/h2>\n\n\n\n4.1 Mettre le syst\u00e8me \u00e0 jour<\/h3>\n\n\n\nsudo apt update && sudo apt upgrade -y<\/code><\/pre>\n\n\n\n\napt update<\/code> met \u00e0 jour la liste des paquets.<\/li>\n\n\n\napt upgrade<\/code> installe les nouvelles versions.<\/li>\n\n\n\n-y<\/code> valide automatiquement les confirmations.<\/li>\n<\/ul>\n\n\n\n4.2 Installer Python et venv<\/h3>\n\n\n\nsudo apt install python3 python3-pip python3-venv -y<\/code><\/pre>\n\n\n\nPaquets install\u00e9s :<\/p>\n\n\n\n
\npython3<\/code> : interpr\u00e9teur Python ;<\/li>\n\n\n\npython3-pip<\/code> : gestionnaire de paquets Python ;<\/li>\n\n\n\npython3-venv<\/code> : environnement virtuel Python.<\/li>\n<\/ul>\n\n\n\n4.3 Cr\u00e9er le projet<\/h3>\n\n\n\nmkdir -p ~\/projets\/flask-api
cd ~\/projets\/flask-api<\/code><\/pre>\n\n\n\n\nmkdir -p<\/code> cr\u00e9e les dossiers n\u00e9cessaires.<\/li>\n\n\n\ncd<\/code> permet d\u2019entrer dans le r\u00e9pertoire.<\/li>\n<\/ul>\n\n\n\n4.4 Cr\u00e9er un environnement virtuel<\/h3>\n\n\n\npython3 -m venv venv<\/code><\/pre>\n\n\n\nCette commande cr\u00e9e un environnement Python isol\u00e9.<\/p>\n\n\n\n
4.5 Activer l\u2019environnement virtuel<\/h3>\n\n\n\nsource venv\/bin\/activate<\/code><\/pre>\n\n\n\nLe shell utilise maintenant les paquets Python du projet.<\/p>\n\n\n\n
4.6 Installer Flask<\/h3>\n\n\n\npip install flask<\/code><\/pre>\n\n\n\nTu peux \u00e9galement installer Werkzeug et Gunicorn :<\/p>\n\n\n\n
pip install gunicorn<\/code><\/pre>\n\n\n\n\ngunicorn<\/code> sert \u00e0 ex\u00e9cuter Flask en production.<\/li>\n<\/ul>\n\n\n\n5. Arborescence recommand\u00e9e du projet<\/h2>\n\n\n\nflask-api\/
\u251c\u2500\u2500 app.py
\u251c\u2500\u2500 requirements.txt
\u251c\u2500\u2500 venv\/
\u251c\u2500\u2500 logs\/
\u2502 \u2514\u2500\u2500 api.log
\u251c\u2500\u2500 static\/
\u2514\u2500\u2500 templates\/<\/code><\/pre>\n\n\n\nExplications :<\/p>\n\n\n\n
\napp.py<\/code> : application principale ;<\/li>\n\n\n\nrequirements.txt<\/code> : d\u00e9pendances Python ;<\/li>\n\n\n\nlogs\/<\/code> : journaux applicatifs ;<\/li>\n\n\n\nstatic\/<\/code> : fichiers statiques ;<\/li>\n\n\n\ntemplates\/<\/code> : templates HTML si besoin.<\/li>\n<\/ul>\n\n\n\n6. Synth\u00e8se Markdown pour ta fiche bristol<\/h2>\n\n\n\n# API Flask
## Installation
sudo apt install python3 python3-pip python3-venv -y
python3 -m venv venv
source venv\/bin\/activate
pip install flask gunicorn
## Lancer l'API
python3 app.py
## Route GET
@app.route(\"\/api\/status\", methods=[\"GET\"])
## Retour JSON
return jsonify({\"status\": \"ok\"})
## Lire le JSON re\u00e7u
data = request.get_json()
## Tester avec curl
curl http:\/\/127.0.0.1:5000\/api\/status
curl -X POST http:\/\/127.0.0.1:5000\/api\/users \\
-H \"Content-Type: application\/json\" \\
-d '{\"nom\":\"alice\"}'
## Pare-feu UFW
sudo ufw allow 5000\/tcp
## Logs systemd
journalctl -u flask-api.service -f<\/code><\/pre>\n\n\n\n7. Fichiers importants<\/h2>\n\n\n\nApplication Flask<\/h3>\n\n\n\n~\/projets\/flask-api\/app.py<\/code><\/pre>\n\n\n\nEnvironnement virtuel<\/h3>\n\n\n\n~\/projets\/flask-api\/venv\/<\/code><\/pre>\n\n\n\nD\u00e9pendances Python<\/h3>\n\n\n\n~\/projets\/flask-api\/requirements.txt<\/code><\/pre>\n\n\n\nLogs applicatifs<\/h3>\n\n\n\n~\/projets\/flask-api\/logs\/api.log<\/code><\/pre>\n\n\n\nService systemd<\/h3>\n\n\n\n\/etc\/systemd\/system\/flask-api.service<\/code><\/pre>\n\n\n\nConfiguration UFW<\/h3>\n\n\n\n\/etc\/ufw\/user.rules<\/code><\/pre>\n\n\n\n8. Configuration compl\u00e8te d\u2019une API Flask<\/h2>\n\n\n\n#!\/usr\/bin\/env python3
# -*- coding: utf-8 -*-
from flask import Flask, jsonify, request
import logging
from logging.handlers import RotatingFileHandler
app = Flask(__name__)
# Configuration des logs
handler = RotatingFileHandler(
\"logs\/api.log\",
maxBytes=1000000,
backupCount=3
)
handler.setLevel(logging.INFO)
formatter = logging.Formatter(
\"%(asctime)s %(levelname)s %(message)s\"
)
handler.setFormatter(formatter)
app.logger.addHandler(handler)
# Base de donn\u00e9es temporaire
users = [
{\"id\": 1, \"nom\": \"alice\"},
{\"id\": 2, \"nom\": \"bob\"}
]
@app.route(\"\/api\/status\", methods=[\"GET\"])
def status():
\"\"\"
Retourne l'\u00e9tat de l'API.
\"\"\"
app.logger.info(\"Consultation du status API\")
return jsonify({
\"status\": \"ok\",
\"service\": \"flask-api\"
})
@app.route(\"\/api\/users\", methods=[\"GET\"])
def get_users():
\"\"\"
Retourne la liste des utilisateurs.
\"\"\"
app.logger.info(\"Lecture des utilisateurs\")
return jsonify(users)
@app.route(\"\/api\/users\", methods=[\"POST\"])
def add_user():
\"\"\"
Ajoute un utilisateur.
\"\"\"
data = request.get_json()
if not data or \"nom\" not in data:
return jsonify({
\"erreur\": \"Champ nom manquant\"
}), 400
user = {
\"id\": len(users) + 1,
\"nom\": data[\"nom\"]
}
users.append(user)
app.logger.info(f\"Ajout utilisateur : {data['nom']}\")
return jsonify(user), 201
@app.route(\"\/api\/users\/<int:user_id>\", methods=[\"DELETE\"])
def delete_user(user_id):
\"\"\"
Supprime un utilisateur.
\"\"\"
global users
users = [
user for user in users
if user[\"id\"] != user_id
]
app.logger.warning(f\"Suppression utilisateur ID {user_id}\")
return jsonify({
\"message\": \"Utilisateur supprim\u00e9\"
})
if __name__ == \"__main__\":
app.run(
host=\"0.0.0.0\",
port=5000,
debug=False
)<\/code><\/pre>\n\n\n\n9. Comprendre le code Flask en d\u00e9tail<\/h2>\n\n\n\n9.1 Cr\u00e9er l\u2019application Flask<\/h3>\n\n\n\napp = Flask(__name__)<\/code><\/pre>\n\n\n\nCette ligne initialise l\u2019application web.<\/p>\n\n\n\n
9.2 D\u00e9finir une route<\/h3>\n\n\n\n@app.route(\"\/api\/status\", methods=[\"GET\"])<\/code><\/pre>\n\n\n\n\n\/api\/status<\/code> : URL appel\u00e9e ;<\/li>\n\n\n\nmethods=[\"GET\"]<\/code> : m\u00e9thodes HTTP autoris\u00e9es.<\/li>\n<\/ul>\n\n\n\n9.3 Retourner du JSON<\/h3>\n\n\n\nreturn jsonify({
\"status\": \"ok\"
})<\/code><\/pre>\n\n\n\njsonify()<\/code> transforme automatiquement les donn\u00e9es Python en JSON.<\/p>\n\n\n\n9.4 Lire des donn\u00e9es JSON<\/h3>\n\n\n\ndata = request.get_json()<\/code><\/pre>\n\n\n\nCette m\u00e9thode lit le contenu JSON envoy\u00e9 par le client.<\/p>\n\n\n\n
9.5 Utiliser les codes HTTP<\/h3>\n\n\n\nreturn jsonify(data), 201<\/code><\/pre>\n\n\n\nCode HTTP courant :<\/p>\n\n\n\nCode<\/th> Signification<\/th><\/tr><\/thead> 200<\/td> Succ\u00e8s<\/td><\/tr> 201<\/td> Ressource cr\u00e9\u00e9e<\/td><\/tr> 400<\/td> Mauvaise requ\u00eate<\/td><\/tr> 401<\/td> Non authentifi\u00e9<\/td><\/tr> 403<\/td> Acc\u00e8s interdit<\/td><\/tr> 404<\/td> Ressource absente<\/td><\/tr> 500<\/td> Erreur serveur<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n10. Tester l\u2019API<\/h2>\n\n\n\n10.1 D\u00e9marrer Flask<\/h3>\n\n\n\npython3 app.py<\/code><\/pre>\n\n\n\nPar d\u00e9faut Flask \u00e9coute sur :<\/p>\n\n\n\n
0.0.0.0:5000<\/code><\/pre>\n\n\n\nPort utilis\u00e9 :<\/p>\n\n\n\n
\n- TCP 5000<\/li>\n<\/ul>\n\n\n\n
10.2 Tester avec curl<\/h3>\n\n\n\nLire le status<\/h3>\n\n\n\ncurl http:\/\/127.0.0.1:5000\/api\/status<\/code><\/pre>\n\n\n\nLire les utilisateurs<\/h3>\n\n\n\ncurl http:\/\/127.0.0.1:5000\/api\/users<\/code><\/pre>\n\n\n\nAjouter un utilisateur<\/h3>\n\n\n\ncurl -X POST http:\/\/127.0.0.1:5000\/api\/users \\
-H \"Content-Type: application\/json\" \\
-d '{\"nom\":\"charlie\"}'<\/code><\/pre>\n\n\n\nExplications :<\/p>\n\n\n\n
\n-X POST<\/code> : m\u00e9thode HTTP ;<\/li>\n\n\n\n-H<\/code> : ajoute un header HTTP ;<\/li>\n\n\n\n-d<\/code> : envoie des donn\u00e9es.<\/li>\n<\/ul>\n\n\n\n11. G\u00e9rer les m\u00e9thodes HTTP<\/h2>\n\n\n\nM\u00e9thode<\/th> Utilisation<\/th><\/tr><\/thead> GET<\/td> Lire<\/td><\/tr> POST<\/td> Ajouter<\/td><\/tr> PUT<\/td> Modifier<\/td><\/tr> DELETE<\/td> Supprimer<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nExemple PUT :<\/p>\n\n\n\n
@app.route(\"\/api\/users\/<int:user_id>\", methods=[\"PUT\"])<\/code><\/pre>\n\n\n\n12. Utiliser des param\u00e8tres et du JSON<\/h2>\n\n\n\nParam\u00e8tre dans l\u2019URL<\/h3>\n\n\n\n@app.route(\"\/api\/users\/<int:user_id>\")<\/code><\/pre>\n\n\n\nFlask r\u00e9cup\u00e8re automatiquement :<\/p>\n\n\n\n
def get_user(user_id):<\/code><\/pre>\n\n\n\nParam\u00e8tre GET<\/h3>\n\n\n\n
Exemple :<\/p>\n\n\n\n
\/api\/search?nom=alice<\/code><\/pre>\n\n\n\nLecture :<\/p>\n\n\n\n
request.args.get(\"nom\")<\/code><\/pre>\n\n\n\n13. S\u00e9curiser une API Flask<\/h2>\n\n\n\n13.1 D\u00e9sactiver le mode debug<\/h3>\n\n\n\n
Ne laisse jamais :<\/p>\n\n\n\n
debug=True<\/code><\/pre>\n\n\n\nen production.<\/p>\n\n\n\n
Le mode debug expose des informations sensibles.<\/p>\n\n\n\n
13.2 Utiliser Gunicorn<\/h3>\n\n\n\n
Installation :<\/p>\n\n\n\n
pip install gunicorn<\/code><\/pre>\n\n\n\nD\u00e9marrage :<\/p>\n\n\n\n
gunicorn -w 4 -b 0.0.0.0:5000 app:app<\/code><\/pre>\n\n\n\nExplications :<\/p>\n\n\n\n
\n-w 4<\/code> : 4 workers ;<\/li>\n\n\n\n-b<\/code> : adresse d\u2019\u00e9coute.<\/li>\n<\/ul>\n\n\n\n13.3 Utiliser un reverse proxy Nginx<\/h3>\n\n\n\n
Architecture recommand\u00e9e :<\/p>\n\n\n\n
Internet
|
Nginx :80 \/ :443
|
Gunicorn :5000
|
Flask<\/code><\/pre>\n\n\n\n13.4 Ajouter une authentification simple<\/h3>\n\n\n\n
Exemple avec un token :<\/p>\n\n\n\n
API_TOKEN = \"super-token\"<\/code><\/pre>\n\n\n\nV\u00e9rification :<\/p>\n\n\n\n
token = request.headers.get(\"Authorization\")<\/code><\/pre>\n\n\n\n13.5 Limiter l\u2019exposition r\u00e9seau<\/h3>\n\n\n\n
Si l\u2019API reste locale :<\/p>\n\n\n\n
host=\"127.0.0.1\"<\/code><\/pre>\n\n\n\nAinsi Flask n\u2019\u00e9coute pas sur le r\u00e9seau.<\/p>\n\n\n\n
14. Configurer le pare-feu UFW<\/h2>\n\n\n\nAutoriser le port Flask<\/h3>\n\n\n\nsudo ufw allow 5000\/tcp<\/code><\/pre>\n\n\n\nV\u00e9rifier les r\u00e8gles<\/h3>\n\n\n\nsudo ufw status verbose<\/code><\/pre>\n\n\n\nSupprimer une r\u00e8gle<\/h3>\n\n\n\nsudo ufw delete allow 5000\/tcp<\/code><\/pre>\n\n\n\nCas recommand\u00e9 en production<\/h3>\n\n\n\n
Si Nginx sert de reverse proxy :<\/p>\n\n\n\n
sudo ufw allow 80\/tcp
sudo ufw allow 443\/tcp
sudo ufw deny 5000\/tcp<\/code><\/pre>\n\n\n\nDans ce cas :<\/p>\n\n\n\n
\n- Internet acc\u00e8de \u00e0 Nginx ;<\/li>\n\n\n\n
- Flask reste inaccessible directement.<\/li>\n<\/ul>\n\n\n\n
15. Superviser et analyser les logs<\/h2>\n\n\n\n15.1 Logs Flask<\/h3>\n\n\n\n
Fichier :<\/p>\n\n\n\n
logs\/api.log<\/code><\/pre>\n\n\n\nExemple :<\/p>\n\n\n\n
2026-05-22 15:00:10 INFO Lecture des utilisateurs
2026-05-22 15:01:12 WARNING Suppression utilisateur ID 2<\/code><\/pre>\n\n\n\n15.2 Lire les logs en direct<\/h3>\n\n\n\ntail -f logs\/api.log<\/code><\/pre>\n\n\n\n\n-f<\/code> suit le fichier en temps r\u00e9el.<\/li>\n<\/ul>\n\n\n\n15.3 Logs systemd<\/h3>\n\n\n\nCr\u00e9er un service<\/h3>\n\n\n\n
Fichier :<\/p>\n\n\n\n
\/etc\/systemd\/system\/flask-api.service<\/code><\/pre>\n\n\n\nContenu :<\/p>\n\n\n\n
[Unit]
Description=API Flask
After=network.target
[Service]
User=www-data
WorkingDirectory=\/home\/user\/projets\/flask-api
ExecStart=\/home\/user\/projets\/flask-api\/venv\/bin\/gunicorn -w 4 -b 0.0.0.0:5000 app:app
Restart=always
[Install]
WantedBy=multi-user.target<\/code><\/pre>\n\n\n\nActiver le service<\/h3>\n\n\n\nsudo systemctl daemon-reload
sudo systemctl enable flask-api
sudo systemctl start flask-api<\/code><\/pre>\n\n\n\nLire les logs<\/h3>\n\n\n\njournalctl -u flask-api -f<\/code><\/pre>\n\n\n\nCe que tu peux analyser<\/h3>\n\n\n\n
Tu peux observer :<\/p>\n\n\n\n
\n- les erreurs Python ;<\/li>\n\n\n\n
- les crashs ;<\/li>\n\n\n\n
- les connexions ;<\/li>\n\n\n\n
- les red\u00e9marrages ;<\/li>\n\n\n\n
- les erreurs r\u00e9seau ;<\/li>\n\n\n\n
- les probl\u00e8mes de permissions.<\/li>\n<\/ul>\n\n\n\n
16. Commandes utiles et d\u00e9pannage<\/h2>\n\n\n\nV\u00e9rifier l\u2019\u00e9coute r\u00e9seau<\/h3>\n\n\n\nss -tulpn | grep 5000<\/code><\/pre>\n\n\n\n\n-t<\/code> : TCP ;<\/li>\n\n\n\n-u<\/code> : UDP ;<\/li>\n\n\n\n-l<\/code> : ports en \u00e9coute ;<\/li>\n\n\n\n-p<\/code> : processus ;<\/li>\n\n\n\n-n<\/code> : affichage num\u00e9rique.<\/li>\n<\/ul>\n\n\n\nTester le port<\/h3>\n\n\n\nnc -vz 127.0.0.1 5000<\/code><\/pre>\n\n\n\nV\u00e9rifier les processus Python<\/h3>\n\n\n\nps aux | grep python<\/code><\/pre>\n\n\n\nV\u00e9rifier Gunicorn<\/h3>\n\n\n\nsystemctl status flask-api<\/code><\/pre>\n\n\n\nV\u00e9rifier le pare-feu<\/h3>\n\n\n\nsudo ufw status numbered<\/code><\/pre>\n\n\n\n17. Cas concrets d\u2019utilisation<\/h2>\n\n\n\nAPI de supervision<\/h3>\n\n\n\n
Un Raspberry Pi peut envoyer :<\/p>\n\n\n\n
\n- temp\u00e9rature ;<\/li>\n\n\n\n
- charge CPU ;<\/li>\n\n\n\n
- \u00e9tat r\u00e9seau.<\/li>\n<\/ul>\n\n\n\n
API pour application mobile<\/h3>\n\n\n\n
Une application Android peut :<\/p>\n\n\n\n
\n- lire des utilisateurs ;<\/li>\n\n\n\n
- ajouter des donn\u00e9es ;<\/li>\n\n\n\n
- r\u00e9cup\u00e9rer des notifications.<\/li>\n<\/ul>\n\n\n\n