start fastapi

Start-Fastapi

Version 2021, basierend auf Fastapi, einer benutzerfreundlichen Web-App, die auf Starlette Framework entwickelt wurde

• Version 2020
• 中文文档

Anforderungen

• Python 3.6+ (für statische Schreibprüfung)
• pip3 install -r ./requirements.txt
  • Fastapi, Uvicorn, Python-dotenv, Python-Multipart, Websockets usw.
• Idee/Pycharm (empfohlen) + Venv

Struktur

Die Webanwendung basiert auf Zwiebelstil ~

Die Verzeichnisstruktur lautet:

• App: Logik für Ihre Anwendung, enthält __init__.py als Eintrag von Benutzermodulen
  • Handler: Controller
  • Middleware: Router Middleware, wie CORs
  • Modell: Grundlegende Datenmodelle und interne Logik
  • Service: Externe Logik (für Benutzer)
• CFG: Konfiguration verschiedener Envs
  • Dev: Konfigurationen von Dev Env
    • app.cfg: python-dotenv cfg für fastapi
    • Uvicorn.json: CFG für Uvicorn ASGI -Server, der Launcher für Fastapi
    • logger.json: cfg für uvicorn anmelden
  • prod: Konfigurationen von Produktionsummen
• Kern: Bibliotheken und Logiken auf niedriger Ebene, beinhaltet __init__.py als Eintritt von Kernmodulen. Machen Sie es besser in der Lage, in anderen Projekten wiederverwendet zu werden
  • Handler
  • LIB: Verknüpfungs -APIs für Benutzer, um Logik zu erstellen
  • Modell
  • Service
    • trans: Transaktionsdienst zum Verwalten von Aufgaben, die im Hintergrund ausgeführt werden
• Verschiedene: Verschiedene Teile, wie Build, Testskripte usw.
  • Build: Skripte erstellen
  • Dev: Ressourcen für die Nutzung des Entwicklers
    • Gen_code.py: Ein Skript zum Generieren von Codes
  • DOC: Docs
  • Test: Testskripte
• Main.Py: Haupteintrag, initieren Sie Uvicorn und Starten Sie die Fastapi -App
• Anforderungen.txt: PY -Paketanforderungen

Schneller Start

App Server starten

Run ./main.py , um das Beispiel zu starten, das enthält:

• Kernmodule: Health Check -Handler, Grundmodelle, Transaktionsservice
• CORS Middleware konfiguriert mit Wildcard *
• Testen Sie Handler, Modelle und Service: simuliert ein einfaches Markthandelssystem mit Produkten und Kunden
  • Beispiele für WebSocket- und Upload -Datei sind auch in Testhandlern enthalten

Die internen Schritte sind:

• ./main.py lädt die Konfigurationen in ./cfg/{env} auf CMD Args und ruft uvicorn.run auf, um die Fastapi -App unter ./app/__init__.py zu starten
• in ./app/__init__.py , Kernmodule und Benutzerhandler/Modelle/Dienste werden beim startup der Fastapi -App geladen

Sie können Ihre Startskripte in die Einstiegs -Skripte einstellen ./misc/build für Ihre verschiedenen Startoptionen

Codierungshandbuch

Um Ihre Logik aufzubauen, folgen gemeinsame Schritte:

• ./main.py führt den Server in Dev-Umgebung in Standard aus, in dem Hot-Reload aktiviert ist
• Fügen Sie Handler in ./app/handler hinzu, fügen Sie den entsprechenden import hinzu und APP.include_router codes in ./app/__init__.py
• Fügen Sie Datenmodelle in ./app/model hinzu, fügen Sie Dienste in ./app/service hinzu
• Fügen Sie bei Bedarf Middlewares in ./app/middleware hinzu

Einige Tipps zum Codieren:

• Holen Sie sich /docs , um die Router auf der Webseite zu testen
• Vermeiden Sie die Verwendung von Coroutinen ( async def -Funktionen), da es die Haupt -EVTLOOP blockieren kann, damit andere Anfragen nicht rechtzeitig behandelt werden. def -Funktionen werden in verschiedenen Threads aufgerufen
• Die Codes von ./core sollten gemeinsam nutzbar sein (für andere Projekte), Codes von ./app sollte zum aktuellen Projekt passen
• Sie können ./misc/dev/gen_code.py verwenden, um Vorlagencodes für Handler, Modelle und Dienste zu generieren. Führen Sie es mit dem Arbeitsverzeichnis als Projektroot -Verzeichnis aus
• Codemodelle basierend auf pydantic.BaseModel , es ist mächtig

HTTP -Antwort

Die meisten der bearbeiteten Anfragen sollten einen Statuscode von 200 enthalten

Eine einfache Lösung besteht darin, Resp -Modell in ./core/model/handler.py zu verwenden, um Reaktionskörper für Ihre Handler zu generieren

 {
  "success": bool,
  "message": str,
  "code": IntEnum,
  "data": Any,
}

Verwenden Sie Resp.ok , um eine Erfolgsantwort zu generieren und Resp.err zu verwenden, um Fehlerantwort zu generieren

Miser

Websocket

Der Testhandler ./app/handler/test.py enthält WS -Handler -Beispiele

Weitere Informationen darüber finden Sie in WebSocket -Dokumentation

Einsatz

Run ./misc/build/pack.sh , um das Projekt in ./misc/build/start-fastapi.tar.gz zu packen

Siehe ./misc/build/Dockerfile für ein Beispiel für die Docker -Bereitstellung