Comment créer une API RESTful à l'aide de Flask

Dans le domaine actuel du développement logiciel, l'API RESTful est devenue un composant essentiel de nombreuses applications, qui peuvent fournir des services fiables, découplés et faciles à maintenir. Flask est un framework Web Python léger qui offre un moyen flexible de créer des applications Web ainsi que des API RESTful. Dans cet article, nous expliquerons comment utiliser Flask pour créer une API RESTful.

1. Install Flask

Tout d'abord, vous devez vous assurer que Python et pip sont installés. Ouvrez un terminal ou une invite de commande sur votre système et entrez la commande suivante pour installer Flask :

pip install Flask

2. Créer un dossier de projet

Dans cet exemple, nous créons un dossier de projet nommé "flask-restful". Entrez la commande suivante dans le terminal pour créer le dossier :

mkdir flask-restful

3. Créer un environnement virtuel

Il est recommandé d'utiliser un environnement virtuel pour évitez d'installer Flask à l'échelle mondiale, ce qui peut nous aider à développer plusieurs projets sur le même ordinateur. Saisissez la commande suivante dans le terminal pour créer un environnement virtuel :

python3 -m venv env

4. activate virtual Environment

Pour activer un environnement virtuel dans le terminal, entrez les commandes suivantes :

Pour Mac/Linux :

source env/bin/activate

Pour Windows :

envScriptsctivate

5. Ajouter les dépendances nécessaires

Dans une application Flask, vous devez utiliser la bibliothèque flask_restful et d'autres bibliothèques pour effectuer en toute sécurité des requêtes API RESTful. Ces dépendances peuvent être installées à l'aide de la commande pip dans un environnement virtuel :

pip install flask_restful
pip install flask_cors

6. Créer le fichier maître de l'application

lors de la création de notre API RESTful Avant , nous devons créer un fichier maître d'application. Créez un fichier appelé "app.py" dans le dossier du projet et ajoutez le code suivant :

from flask import Flask
from flask_restful import Api, Resource, reqparse

app = Flask(__name__)
api = Api(app)

users = [
    {
        "name": "Alice",
        "age": 22,
        "occupation": "Software Engineer"
    },
    {
        "name": "Bob",
        "age": 26,
        "occupation": "Data Analyst"
    },
    {
        "name": "Charlie",
        "age": 33,
        "occupation": "UI/UX Designer"
    }
]

class User(Resource):
    def get(self, name):
        for user in users:
            if(name == user["name"]):
                return user, 200
        return "User not found", 404

api.add_resource(User, "/user/<string:name>")

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

Le code ci-dessus crée une instance d'application Flask appelée "app" et un objet The flask_restful de "api". Il définit également certaines données pour stocker les informations utilisateur. Dans cette application, nous définissons également une classe appelée "User", qui hérite de la classe "Resource" de flask_restful. La classe User définit deux méthodes : get et post. Nous avons uniquement implémenté la méthode get, qui est utilisée pour obtenir des données utilisateur avec un nom spécifié. Enfin, liez la classe User au point de terminaison /user/

7. Exécuter l'application

Dans un terminal ou une invite de commande, saisissez la commande suivante pour lancer l'application :

python app.py

#🎜 🎜#Ensuite, visitez http://localhost:5000/user/Alice (ou le nom d'un autre utilisateur) pour obtenir les données utilisateur.

Ajouter le support CORS

CORS signifie Cross-Origin Resource Sharing. Lors de l'utilisation des API RESTful, la prise en charge CORS peut être utilisée dans l'environnement de développement pour éviter les problèmes de ressources entre domaines. Dans notre application, nous avons ajouté le support CORS à l'aide de la bibliothèque flask_cors. Pour ajouter le support CORS, ajoutez simplement le code suivant au fichier principal de votre application :

from flask_cors import CORS

app = Flask(__name__)
api = Api(app)
CORS(app)

Ce code est ajouté après l'instance d'application et la définition de l'API. Il lie le middleware CORS à l'instance d'application.

Conclusion

Dans cet article, nous avons présenté comment créer une API RESTful à l'aide de Flask. Nous commençons par installer Flask, puis créons le dossier du projet, l'environnement virtuel, ajoutons des dépendances et créons le fichier principal de l'application. Nous avons également appris comment ajouter la prise en charge CORS pour aider à résoudre les problèmes de demandes de ressources multi-origines. Vous pouvez désormais facilement créer des services API RESTful à l'aide de Flask.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!