الصفحة الرئيسية>موارد بناء الموقع>بيانات الموقع
تنزيل

بدء الصب

الإصدار 2021 ، استنادًا إلى Fastapi ، تطبيق ويب سهل الاستخدام تم تطويره على Starlette Framework

  • الإصدار 2020
  • 中文文档

متطلبات

  • Python 3.6+ (لفحص الكتابة الثابتة)
  • pip3 install -r ./requirements.txt
    • fastapi ، uvicorn ، python-dotenv ، python-multipart ، websockets ، إلخ
  • فكرة/pycharm (موصى بها) + VenV

بناء

يعتمد تطبيق الويب على نمط البصل ~

هيكل الدليل هو:

  • التطبيق: منطق التطبيق الخاص بك ، يتضمن __init__.py كمدخل لوحدات المستخدم
    • المعالج: وحدات التحكم
    • البرامج الوسيطة: أدوات التوجيه الوسيطة ، مثل cors
    • النموذج: نماذج البيانات الأساسية والمنطق الداخلي
    • الخدمة: المنطق الخارجي (للمستخدمين)
  • CFG: تكوين Envs مختلف
    • DEV: تكوينات Dev Env
      • app.cfg: python-dotenv cfg لـ fastapi
      • uvicorn.json: CFG لخادم uvicorn ASGI ، قاذفة fastapi
      • logger.json: تسجيل CFG لـ Uvicorn
    • Prod: تكوينات الإنتاج ENV
  • Core: المكتبات المنخفضة المستوى والمنطق ، تتضمن __init__.py كدخول للوحدات الأساسية ، من الأفضل إعادة استخدامها في مشاريع أخرى
    • معالج
    • LIB: اختصار واجهات برمجة التطبيقات للمستخدم لبناء المنطق
    • نموذج
    • خدمة
      • Trans: خدمة المعاملات ، لإدارة المهام التي تعمل في الخلفية
  • MISC: أجزاء متفرقات ، مثل البناء ، البرامج النصية للاختبار ، إلخ
    • بناء: بناء البرامج النصية
    • DEV: موارد لاستخدام DEV
      • gen_code.py: برنامج نصي لإنشاء الرموز
    • DOC: مستندات
    • الاختبار: اختبار البرامج النصية
  • Main.py: الدخول الرئيسي ، init uvicorn وابدأ تطبيق Fastapi
  • المتطلبات. txt: متطلبات حزمة PY

بداية سريعة

تشغيل خادم التطبيق

Run ./main.py لبدء المثال ، والذي يتضمن:

  • الوحدات الأساسية: معالج الفحص الصحي ، النماذج الأساسية ، خدمة المعاملات
  • تم تكوين البرامج الوسيطة cors مع Wildcard *
  • معالجات الاختبار والنماذج والخدمة: يحاكي نظام تجارة السوق البسيط مع المنتجات والعملاء
    • يتم أيضًا تضمين أمثلة على ملف WebSocket وملف التحميل في معالجات الاختبار

الخطوات الداخلية هي:

  • ./main.py ./cfg/{env} uvicorn.run ./app/__init__.py
  • startup ./app/__init__.py

يمكنك وضع البرامج النصية للتشغيل في الداخل ./misc/build لخيارات الإطلاق المختلفة الخاصة بك

دليل الترميز

لبناء منطقك ، تتبع الخطوات المشتركة:

  • ./main.py
  • إضافة معالجات في ./app/handler ، أضف import و APP.include_router في ./app/__init__.py
  • إضافة نماذج البيانات في ./app/model ، أضف الخدمات في ./app/service
  • أضف الأدوات الوسطى في ./app/middleware إذا لزم الأمر

بعض النصائح للترميز:

  • الحصول على /docs لاختبار أجهزة التوجيه على صفحة الويب
  • تجنب استخدام Coroutines (وظائف async def ) ، حيث قد تمنع Evtloop الرئيسية ، بحيث لا يتم التعامل مع الطلبات الأخرى في الوقت المناسب. سيتم استدعاء وظائف def في مؤشرات ترابط مختلفة
  • يجب مشاركة رموز ./core (للمشاريع الأخرى) ، يجب أن تتناسب رموز ./app
  • يمكنك استخدام ./misc/dev/gen_code.py لإنشاء رموز قالب للمعالجات والموديلات والخدمات. exect مع دليل العمل كدليل جذر المشروع
  • نماذج التعليمات البرمجية القائمة على pydantic.BaseModel ، إنها قوية

استجابة HTTP

يجب أن تحتوي معظم طلبات المعالجة على رمز الحالة 200

الحل البسيط هو استخدام نموذج Resp في ./core/model/handler.py لإنشاء جسم استجابة لمعالجاتك 

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

استخدم Resp.ok لإنشاء استجابة النجاح واستخدام Resp.err لتوليد استجابة الخطأ

متفرقات

WebSocket

يحتوي معالج الاختبار ./app/handler/test.py على أمثلة معالج WS

لمعرفة المزيد حول هذا الموضوع ، راجع وثائق WebSocket

النشر

Run ./misc/build/pack.sh لتعبئة المشروع في ./misc/build/start-fastapi.tar.gz

انظر ./misc/build/Dockerfile للحصول على مثال على نشر Docker

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل