Écrire une API simple en Python avec Flask

Imaginez que vous vouliez créer votre première application Web ou créer une interface de programmation (API) capable de recevoir des requêtes et de renvoyer des réponses. Cela semble compliqué ? En fait, avec Flask, un framework web simple mais puissant pour Python, c'est très facile à faire. Aujourd'hui, je vais vous montrer comment écrire rapidement une API simple qui peut accepter les demandes et y répondre.

Qu'est-ce que Flask ?

Flask est un framework Web léger pour Python qui facilite la création d'applications Web et d'API. Il est facile à utiliser et à apprendre, et est idéal pour les petits projets ou pour le prototypage rapide d'idées. Flask est un excellent choix pour ceux qui veulent comprendre rapidement comment fonctionne le développement Web et comment écrire une API.

Commençons : Installation de Flask

Avant de commencer à écrire du code, nous devons installer Flask. Pour ce faire, ouvrez le terminal et exécutez la commande suivante :

pip install Flask

Après cela, vous aurez installé Flask et vous pourrez commencer à écrire notre première API.

Créons la première API Flask

Créons maintenant un fichier nommé app.py. Dans ce fichier, nous allons écrire le code de notre API. Ouvrez l'éditeur de code et collez le code suivant :

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def home():
    return "Welcome to our simple API!"

@app.route('/api/greet', methods=['GET'])
def greet():
    response = {
        "message": "Hello! This is a response from our API."
    }
    return jsonify(response)

if __name__ == '__main__':
    app.run(debug=True)

Voyons ce qui se passe ici :

• Nous importons Flask et json: Flask nous permet de créer une application Web et jsonify est utilisé pour renvoyer des données au format JSON.

• Créons une instance de Flask: app = Flask(__name__) — c'est ce qui crée notre application.

• Itinéraires (@app.route()): Une route est un moyen de lier une URL à une fonction. Par exemple, @app.route('/') relie la page racine à la fonction home, qui renvoie un message de bienvenue.

• Fonction greet() : Elle traite la requête à l'adresse /api/greet et renvoie une réponse JSON.

Lancer l'API

Pour lancer notre API, retournez au terminal et exécutez la commande suivante :

python app.py

Après cela, Flask lancera le serveur et vous verrez un message comme :

 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Vous pouvez maintenant ouvrir votre navigateur et aller à http://127.0.0.1:5000/ pour voir le message « Bienvenue dans notre API simple ! ». Et si vous allez à l'adresse http://127.0.0.1:5000/api/greet, vous verrez un JSON avec un message de bienvenue.

Nous ajoutons de nouvelles fonctionnalités

Créer une API sur Flask, c'est comme jouer à un jeu de construction : vous pouvez ajouter de nouveaux itinéraires et de nouvelles fonctionnalités pour que l'API puisse en faire plus. Ajoutons un itinéraire qui prendra le nom de l'utilisateur et l'accueillera :

from flask import request

@app.route('/api/greet/<name>', methods=['GET'])
def greet_user(name):
    response = {
        "message": f"Hi {name}! This is a personal greeting from our API."
    }
    return jsonify(response)

Maintenant, si vous ouvrez http:// 127.0.0.1:5000/api/greet/Vasya, l'API vous renverra un message personnalisé « Bonjour, Vasya ! »

Pourquoi Flask : c'est simple et puissant

Flask est un outil formidable qui vous permet de créer rapidement des prototypes et d'apprendre le développement Web sans passer beaucoup de temps à étudier des frameworks complexes. Il est léger, facile à comprendre et en même temps assez puissant pour gérer la plupart des tâches.

Contrairement à d'autres frameworks tels que Django, Flask ne nécessite pas beaucoup de paramètres et de fichiers supplémentaires. Il vous donne de la flexibilité et du contrôle sur le projet, ce qui est particulièrement important si vous débutez dans la programmation.

Conclusion

Vous savez maintenant comment créer une API Python simple avec Flask. C'est un excellent moyen de commencer votre voyage dans le monde du développement Web et de comprendre le fonctionnement des serveurs et des requêtes des clients. Flask vous aidera à créer votre premier projet facilement et rapidement, puis vous pourrez le rendre plus complexe, ajouter de nouvelles fonctionnalités et apprendre par la pratique.