So erstellen Sie eine RESTful-API mit Flask

Im heutigen Bereich der Softwareentwicklung ist die RESTful API zu einer Kernkomponente vieler Anwendungen geworden, die zuverlässige, entkoppelte und einfach zu wartende Dienste bereitstellen kann. Flask ist ein leichtes Python-Webframework, das eine flexible Möglichkeit zum Erstellen von Webanwendungen sowie RESTful-APIs bietet. In diesem Artikel stellen wir vor, wie Sie Flask zum Erstellen einer RESTful-API verwenden.

1. Flask installieren

Zunächst müssen Sie sicherstellen, dass Python und Pip installiert sind. Öffnen Sie ein Terminal oder eine Eingabeaufforderung in Ihrem System und geben Sie den folgenden Befehl ein, um Flask zu installieren:

pip install Flask

2. Projektordner erstellen

In diesem Beispiel erstellen wir einen Projektordner mit dem Namen „flask-restful“. Geben Sie im Terminal den folgenden Befehl ein, um den Ordner zu erstellen:

mkdir flask-restful

3. Erstellen Sie eine virtuelle Umgebung

Es wird empfohlen, eine virtuelle Umgebung zu verwenden, um die globale Installation von Flask auf dem System zu vermeiden, was uns dabei helfen kann, mehrere Projekte auf demselben zu entwickeln Computer. Geben Sie im Terminal den folgenden Befehl ein, um eine virtuelle Umgebung zu erstellen:

python3 -m venv env

4. Virtuelle Umgebung aktivieren

Um eine virtuelle Umgebung im Terminal zu aktivieren, geben Sie folgenden Befehl ein:

Für Mac/Linux:

source env/bin/activate

Für Windows:

envScriptsctivate

5. Erforderliche Abhängigkeiten hinzufügen

In einer Flask-Anwendung müssen Sie die flask_restful-Bibliothek und andere Bibliotheken verwenden, um RESTful-API-Anfragen sicher auszuführen. Diese Abhängigkeiten können mit dem pip-Befehl in einer virtuellen Umgebung installiert werden:

pip install flask_restful
pip install flask_cors

6. Anwendungsmasterdatei erstellen

Bevor wir unsere RESTful-API erstellen, müssen wir eine Anwendungsmasterdatei erstellen. Erstellen Sie eine Datei mit dem Namen „app.py“ im Projektordner und fügen Sie den folgenden Code hinzu:

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)

Der obige Code erstellt eine Flask-Anwendungsinstanz mit dem Namen „app“ und ein flask_restful-Objekt mit dem Namen „api“. Außerdem werden einige Daten zum Speichern von Benutzerinformationen definiert. In dieser Anwendung definieren wir auch eine Klasse namens „User“, die von der „Resource“-Klasse von flask_restful erbt. Die User-Klasse definiert zwei Methoden: get und post. Wir haben nur die get-Methode implementiert, die zum Abrufen von Benutzerdaten mit einem angegebenen Namen verwendet wird. Binden Sie abschließend die User-Klasse an den Endpunkt /user/df64b2f2eaba890373bab527a3e6d187

7. Führen Sie die Anwendung aus

Geben Sie in einem Terminal oder einer Eingabeaufforderung den folgenden Befehl ein, um die Anwendung zu starten:

python app.py

Besuchen Sie dann http://localhost:5000/user/Alice (oder den Namen eines anderen Benutzers), d. h. This Benutzerdaten liegen vor.

8. CORS-Unterstützung hinzugefügt

CORS steht für Cross-Origin Resource Sharing. Bei Verwendung von RESTful-APIs kann die CORS-Unterstützung in der Entwicklungsumgebung genutzt werden, um domänenübergreifende Ressourcenprobleme zu vermeiden. In unserer Anwendung haben wir CORS-Unterstützung mithilfe der flask_cors-Bibliothek hinzugefügt. Um CORS-Unterstützung hinzuzufügen, fügen Sie einfach den folgenden Code zu Ihrer Anwendungshauptdatei hinzu:

from flask_cors import CORS

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

Dieser Code wird nach der Anwendungsinstanz und der API-Definition hinzugefügt. Es bindet CORS-Middleware an die Anwendungsinstanz.

Fazit

In diesem Artikel haben wir vorgestellt, wie man mit Flask eine RESTful-API erstellt. Wir beginnen mit der Installation von Flask, erstellen dann den Projektordner und die virtuelle Umgebung, fügen Abhängigkeiten hinzu und erstellen die Hauptdatei der Anwendung. Wir haben auch gelernt, wie man CORS-Unterstützung hinzufügt, um Probleme mit ursprungsübergreifenden Ressourcenanforderungen zu lösen. Jetzt können Sie mit Flask ganz einfach RESTful-API-Dienste erstellen.

Das obige ist der detaillierte Inhalt vonSo erstellen Sie eine RESTful-API mit Flask. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!