FastAPI Template

เทมเพลต fastapi

คำอธิบาย

เทมเพลต Fastapi เป็นเทมเพลตโครงการที่ให้โครงสร้างไฟล์ที่ดีและการตั้งค่าสำหรับการสร้างแอปพลิเคชัน Fastapi ซึ่งรวมถึงสภาพแวดล้อมการพัฒนาที่กำหนดค่าล่วงหน้าสคริปต์การปรับใช้พร้อมการผลิตและตัวเลือกการกำหนดค่า SSL เทมเพลตนี้มีจุดมุ่งหมายเพื่อให้นักพัฒนาสามารถเริ่มโครงการ Fastapi ใหม่ได้ง่ายขึ้นด้วยรากฐานที่แข็งแกร่งและแนวปฏิบัติที่ดีที่สุด

คุณสมบัติ

• ทำความสะอาดโครงสร้างไฟล์สำหรับการจัดระเบียบแอปพลิเคชัน fastapi ของคุณ
• การตั้งค่าสภาพแวดล้อมเสมือนจริงสำหรับการพึ่งพาแยก
• สคริปต์ทุบตีพร้อมผลิตสำหรับการปรับใช้
• การตั้งค่า SSL ที่กำหนดค่าได้สำหรับการเชื่อมต่อที่ปลอดภัย
• การบันทึกล่วงหน้าที่กำหนดค่าไว้ล่วงหน้าพร้อมบันทึกที่บันทึกไว้ในไฟล์
• เว็บ UI สำหรับการดูและค้นหาบันทึกด้วยตัวเลือกมากมาย

การติดตั้ง

1. โคลนที่เก็บ:

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. สร้างสภาพแวดล้อมเสมือนจริงและเปิดใช้งาน:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. ติดตั้งการพึ่งพาที่ต้องการ:

pip3 install -r requirements.txt

การใช้งาน

ในการเรียกใช้แอปพลิเคชันในพื้นที่โดยใช้ Uvicorn หรือ Gunicorn:

การใช้ Uvicorn: uvicorn api.main:app --reload --port 8086

การใช้ Gunicorn: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

แอปพลิเคชันจะเริ่มทำงานบน http: // localhost: 8086

การปรับใช้

สำหรับการปรับใช้การผลิตเทมเพลตจะจัดเตรียมไปป์ไลน์ Docker CI และไฟล์การกำหนดค่า docker-compose เทียบท่าเพื่อการปรับใช้ที่ง่าย

การบริจาค

ยินดีต้อนรับ! หากคุณต้องการมีส่วนร่วมในเทมเพลต fastapi โปรดทำตามขั้นตอนเหล่านี้:

1. แยกที่เก็บ
2. สร้างสาขาใหม่สำหรับคุณสมบัติหรือการแก้ไขข้อบกพร่องของคุณ
3. ทำการเปลี่ยนแปลงของคุณและกระทำพวกเขา
4. ผลักดันการเปลี่ยนแปลงของคุณไปยังส้อมของคุณ
5. ส่งคำขอดึงไปยังสาขา master ของที่เก็บเดิม

โปรดตรวจสอบให้แน่ใจว่าได้ทำตามรูปแบบรหัสที่มีอยู่และเพิ่มการทดสอบสำหรับคุณสมบัติใหม่หรือการแก้ไขข้อบกพร่อง

ใบอนุญาต

เทมเพลต Fastapi เปิดตัวภายใต้ใบอนุญาต MIT คุณมีอิสระที่จะใช้แก้ไขและแจกจ่ายเทมเพลตนี้เพื่อวัตถุประสงค์ใด ๆ