3.0 KiB
Tutorial - Benutzerhandbuch - Intro
Diese Anleitung zeigt Ihnen Schritt für Schritt, wie Sie FastAPI mit den meisten Funktionen nutzen können.
Jeder Abschnitt baut schrittweise auf den vorhergehenden auf. Diese Abschnitte sind aber nach einzelnen Themen gegliedert, sodass Sie direkt zu einem bestimmten Thema übergehen können, um Ihre speziellen API-Anforderungen zu lösen.
Außerdem dienen diese als zukünftige Referenz.
Dadurch können Sie jederzeit zurückkommen und sehen genau das, was Sie benötigen.
Den Code ausführen
Alle Codeblöcke können kopiert und direkt verwendet werden (da es sich um getestete Python-Dateien handelt).
Um eines der Beispiele auszuführen, kopieren Sie den Code in die Datei main.py, und starten Sie uvicorn mit:
$ uvicorn main:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
<span style="color: green;">INFO</span>: Started reloader process [28720]
<span style="color: green;">INFO</span>: Started server process [28722]
<span style="color: green;">INFO</span>: Waiting for application startup.
<span style="color: green;">INFO</span>: Application startup complete.
Es wird ausdrücklich empfohlen, dass Sie den Code schreiben oder kopieren, ihn bearbeiten und lokal ausführen.
Die Verwendung in Ihrem eigenen Editor zeigt Ihnen die Vorteile von FastAPI am besten, wenn Sie sehen, wie wenig Code Sie schreiben müssen, all die Typprüfungen, die automatische Vervollständigung usw.
FastAPI installieren
Der erste Schritt besteht aus der Installation von FastAPI.
Für dieses Tutorial empfiehlt es sich, FastAPI mit allen optionalen Abhängigkeiten und Funktionen zu installieren:
$ pip install "fastapi[all]"
---> 100%
...dies beinhaltet auch uvicorn, das Sie als Server verwenden können, auf dem Ihr Code läuft.
!!! Hinweis Sie können die Installation auch in einzelnen Schritten ausführen.
Dies werden Sie wahrscheinlich tun, wenn Sie Ihre Anwendung produktiv einsetzen möchten:
```
pip install fastapi
```
Installieren Sie auch `uvicorn`, dies arbeitet als Server:
```
pip install "uvicorn[standard]"
```
Dasselbe gilt für jede der optionalen Abhängigkeiten, die Sie verwenden möchten.
Erweitertes Benutzerhandbuch
Zusätzlich gibt es ein Erweitertes Benutzerhandbuch, dies können Sie später nach diesem Tutorial - Benutzerhandbuch lesen.
Das Erweiterte Benutzerhandbuch baut auf dieses Tutorial auf, verwendet dieselben Konzepte und bringt Ihnen zusätzliche Funktionen bei.
Allerdings sollten Sie zuerst das Tutorial - Benutzerhandbuch lesen (was Sie gerade lesen).
Es ist so konzipiert, dass Sie nur mit dem Tutorial - Benutzerhandbuch eine vollständige Anwendung erstellen können und diese dann je nach Bedarf mit einigen der zusätzlichen Ideen aus dem Erweiterten Benutzerhandbuch erweitern können.