start fastapi

Start-fastapi

Versi 2021, Berdasarkan FastAPI, aplikasi web yang mudah digunakan yang dikembangkan di Starlette Framework

• Versi 2020
• 中文文档

Persyaratan

• Python 3.6+ (untuk pemeriksaan pengetikan statis)
• pip3 install -r ./requirements.txt
  • Fastapi, Uvicorn, Python-Dotenv, Python-Multipart, Websockets, dll
• ide/pycharm (disarankan) + venv

Struktur

Aplikasi web didasarkan pada gaya bawang ~

Struktur direktori adalah:

• Aplikasi: Logika untuk aplikasi Anda, termasuk __init__.py sebagai entri modul pengguna
  • Handler: Pengontrol
  • Middleware: Router Middleware, seperti CORS
  • Model: Model Data Dasar dan Logika Internal
  • Layanan: Logika Eksternal (untuk pengguna)
• CFG: konfigurasi envs yang berbeda
  • dev: configs of dev env
    • App.cfg: CFG Python-Dotenv untuk Fastapi
    • uvicorn.json: CFG untuk server ASGI Uvicorn, peluncur untuk FASTAPI
    • Logger.json: Logging CFG untuk Uvicorn
  • Prod: Configs of Production Env
• Inti: Perpustakaan dan Logika Level Rendah, Termasuk __init__.py sebagai entri modul inti, lebih baik membuatnya dapat digunakan kembali dalam proyek lain
  • pawang
  • Lib: API Pintasan bagi Pengguna untuk Membangun Logika
  • model
  • melayani
    • Trans: Layanan transaksi , untuk mengelola tugas yang berjalan di latar belakang
• Lain -lain: Bagian misc, seperti build, skrip uji, dll
  • Build: Bangun skrip
  • dev: sumber daya untuk penggunaan dev
    • gen_code.py: skrip untuk menghasilkan kode
  • DOC: Docs
  • Tes: Uji skrip
• Main.py: Entri Utama, Init Uvicorn dan Mulai Aplikasi Fastapi
• persyaratan.txt: persyaratan paket py

Awal yang cepat

Luncurkan server aplikasi

Jalankan ./main.py untuk memulai contoh, yang meliputi:

• Modul Inti: Penangan Periksa Kesehatan, Model Dasar, Layanan Transaksi
• Middleware CORS dikonfigurasi dengan wildcard *
• Penangan, Model, dan Layanan Uji: Mensimulasikan Sistem Perdagangan Pasar Sederhana dengan Produk dan Pelanggan
  • Contoh file websocket dan unggah juga termasuk dalam penangan uji

Langkah -langkah internal adalah:

• ./main.py memuat konfigurasi di dalam ./cfg/{env} pada cmd args, lalu memanggil uvicorn.run untuk memulai aplikasi fastapi di ./app/__init__.py
• di ./app/__init__.py , modul inti dan penangan/model/layanan pengguna dimuat pada acara startup aplikasi FastAPI

Anda dapat menempatkan skrip peluncuran Anda di dalam ./misc/build untuk opsi peluncuran Anda yang berbeda

Panduan pengkodean

Untuk membangun logika Anda, langkah -langkah umum adalah berikut:

• ./main.py menjalankan server di lingkungan dev secara default, di mana hot-reload diaktifkan
• Tambahkan penangan di ./app/handler , tambahkan Kode import & APP.include_router yang sesuai di ./app/__init__.py
• Tambahkan model data di ./app/model , tambahkan layanan di ./app/service
• Tambahkan Middlewares di ./app/middleware jika perlu

Beberapa tips untuk pengkodean:

• Dapatkan /docs untuk menguji router di halaman web
• Hindari menggunakan coroutines (fungsi async def ), karena dapat memblokir evtloop utama, sehingga permintaan lain tidak ditangani dalam waktu. fungsi def akan dipanggil di utas yang berbeda
• Kode ./core harus dibagikan (untuk proyek lain), kode ./app harus sesuai dengan proyek saat ini
• Anda dapat menggunakan ./misc/dev/gen_code.py untuk menghasilkan kode template untuk penangan, model & layanan. Jalankan dengan direktori kerja sebagai direktori root proyek
• Model kode berdasarkan pydantic.BaseModel , sangat kuat

Respons http

Sebagian besar permintaan yang ditangani harus berisi kode status 200

Solusi sederhana adalah dengan menggunakan model Resp di ./core/model/handler.py untuk menghasilkan badan respons untuk penangan Anda

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

Gunakan Resp.ok untuk menghasilkan respons keberhasilan dan menggunakan Resp.err untuk menghasilkan respons kesalahan

Misc

Websocket

Test Handler ./app/handler/test.py berisi contoh -contoh penangan WS

Untuk mengetahui lebih banyak tentang itu, lihat dokumentasi WebSocket

Penyebaran

Jalankan ./misc/build/pack.sh untuk mengemas proyek ke ./misc/build/start-fastapi.tar.gz

Lihat ./misc/build/Dockerfile untuk contoh penyebaran Docker