start fastapi

start-fastapi

Version 2021, basée sur Fastapi, une application Web facile à utiliser développée sur Starlette Framework

• Version 2020
• 中文文档

Exigences

• Python 3.6+ (pour le chèque de dactylographie statique)
• pip3 install -r ./requirements.txt
  • Fastapi, Uvicorn, Python-Dotenv, Python-Multipart, WebSockets, etc.
• idée / pycharm (recommandé) + Venv

Structure

L'application Web est basée sur le style d'oignon ~

La structure du répertoire est:

• Application: Logics pour votre application, inclut __init__.py comme entrée des modules utilisateur
  • gestionnaire: contrôleurs
  • Middleware: Router Middleware, comme CORS
  • Modèle: modèles de données de base et logiques internes
  • Service: logiques externes (aux utilisateurs)
• CFG: config de différents env.
  • dev: configs de dev
    • app.cfg: python-dotenv cfg pour fastapi
    • uvicorn.json: CFG pour Uvicorn ASGI Server, le lanceur pour Fastapi
    • Logger.json: journalisation CFG pour Uvicorn
  • prod: configs de production Env
• Core: Bibliothèques et logiques de bas niveau, comprend __init__.py comme entrée des modules de base, il vaut mieux le faire être réutilisé dans d'autres projets
  • maître
  • LIB: API de raccourci pour l'utilisateur pour créer des logiques
  • modèle
  • service
    • Trans: Service de transaction , pour gérer les tâches en cours d'exécution
• Divers: pièces diverses, comme la construction, les scripts de test, etc.
  • CONSTRUCTION: CONSTRUIRE SCRIPTS
  • Dev: Ressources pour l'utilisation du développement
    • gen_code.py: un script pour générer des codes
  • Doc: Docs
  • Test: tester les scripts
• main.py: entrée principale, application init uvicorn et start fastapi
• exigences.txt: exigences du package PY

Démarrage rapide

Lancez le serveur d'applications

Run ./main.py pour démarrer l'exemple, qui comprend:

• Modules de base: gestionnaire de contrôle de santé, modèles de base, service de transaction
• CORS Middleware configuré avec le joker *
• Tester les gestionnaires, les modèles et le service: simule un système de commerce de marché simple avec des produits et des clients
  • Des exemples de fichiers WebSocket et de téléchargement sont également inclus dans les gestionnaires de test

Les étapes internes sont:

• ./main.py charge les configurations à l'intérieur ./cfg/{env} sur CMD Args, puis appelle uvicorn.run pour démarrer l'application Fastapi à ./app/__init__.py
• dans ./app/__init__.py , les modules de base et les gestionnaires / modèles / services sont chargés lors de l'événement startup de l'application Fastapi

Vous pouvez mettre vos scripts de lancement à l'intérieur ./misc/build pour vos différentes options de lancement

Guide de codage

Pour construire votre logique, des étapes courantes suit:

• ./main.py exécute le serveur dans Dev Environment en défaut, dans lequel Hot-Reload est activé
• Ajouter des gestionnaires dans ./app/handler , ajouter des codes import et APP.include_router dans ./app/__init__.py
• Ajouter des modèles de données dans ./app/model , ajouter des services à ./app/service
• Ajouter Middlewares dans ./app/middleware si nécessaire

Quelques conseils pour le codage:

• Obtenez /docs pour tester les routeurs sur la page Web
• Évitez d'utiliser des coroutines (fonctions async def ), car elle peut bloquer l'Evtloop principal, afin que d'autres demandes ne soient pas traitées dans le temps. Les fonctions def seront invoquées dans différents threads
• Les codes de ./core doivent être partageables (pour d'autres projets), les codes de ./app doivent s'adapter au projet actuel
• Vous pouvez utiliser ./misc/dev/gen_code.py pour générer des codes de modèle pour les gestionnaires, les modèles et les services. Exécutez-le avec le répertoire fonctionnel comme répertoire racine de projet
• Modèles de code basés sur pydantic.BaseModel , c'est puissant

Réponse HTTP

La plupart des demandes gérées doivent contenir un code d'état de 200

Une solution simple consiste à utiliser le ./core/model/handler.py Resp

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

Utilisez Resp.ok pour générer une réponse de réussite et utiliser Resp.err pour générer une réponse d'erreur

Mission

Websocket

Le gestionnaire de test ./app/handler/test.py contient des exemples de gestionnaire WS

Pour en savoir plus, voir la documentation WebSocket

Déploiement

Run ./misc/build/pack.sh pour emballer le projet dans ./misc/build/start-fastapi.tar.gz

Voir ./misc/build/Dockerfile pour un exemple de déploiement de Docker