ชุดเริ่มต้นเฟรมเวิร์ก Django Rest Framework
นี่คือเทมเพลตเริ่มต้นสำหรับโครงการ Django Rest Framework (DRF) ที่ออกแบบมาเพื่อให้รากฐานที่มั่นคงพร้อมคุณสมบัติที่จำเป็นโดยทั่วไปที่จำเป็นในการพัฒนา API
คุณสมบัติ
- การรับรองความถูกต้องตามโทเค็น : รักษาความปลอดภัยจุดสิ้นสุด API ของคุณโดยใช้การรับรองความถูกต้องตามโทเค็น
- เอกสาร Swagger API : สร้างเอกสาร API แบบโต้ตอบโดยอัตโนมัติโดยใช้ Swagger UI
- ระบบการจัดการผู้ใช้ : ใช้การลงทะเบียนผู้ใช้การเข้าสู่ระบบการออกจากระบบและฟังก์ชันการรีเซ็ตรหัสผ่าน
- การอนุญาตและบทบาท : กำหนดบทบาทของผู้ใช้และสิทธิ์ในการควบคุมการเข้าถึงจุดสิ้นสุด API
- การแจ้งเตือนทางอีเมล : ตั้งค่าการแจ้งเตือนทางอีเมลสำหรับเหตุการณ์ที่เกี่ยวข้องกับผู้ใช้เช่นการลงทะเบียนและรีเซ็ตรหัสผ่าน
- การ จำกัด อัตรา : ป้องกันการใช้จุดสิ้นสุด API โดยการ จำกัด อัตราการ จำกัด
- การอัปโหลดไฟล์ : สนับสนุนการอัปโหลดไฟล์ (เช่นรูปภาพเอกสาร) พร้อมแบ็กเอนด์ที่เก็บข้อมูลที่ปรับแต่งได้
- การแคช : ปรับปรุงประสิทธิภาพ API ด้วยการแคชสำหรับข้อมูลที่เข้าถึงได้บ่อย
- งานพื้นหลัง : ดำเนินงานพื้นหลังแบบอะซิงโครนัสโดยใช้คื่นฉ่ายและนายหน้าข้อความ
- การตรวจสอบและการบันทึก : ตรวจสอบประสิทธิภาพของแอปพลิเคชันและติดตามข้อผิดพลาดด้วยเครื่องมือการบันทึกและการตรวจสอบ
การใช้งาน
โคลนที่เก็บนี้:
git clone https://github.com/hossainchisty/django-rest-starter-kit.git
ติดตั้งการพึ่งพา:
pip install -r requirements.txt
ปรับแต่งการตั้งค่า:
- กำหนดค่าการตั้งค่าฐานข้อมูลใน
settings.py - ตั้งค่าการกำหนดค่าอีเมลสำหรับการส่งการแจ้งเตือน
- กำหนดค่าการตั้งค่าการตรวจสอบโทเค็น
- ปรับแต่งสิทธิ์และบทบาทตามข้อกำหนดของแอปพลิเคชันของคุณ
โยกย้ายฐานข้อมูล:
เรียกใช้เซิร์ฟเวอร์การพัฒนา:
python manage.py runserver
เข้าถึงเอกสาร API:
เปิดเบราว์เซอร์ของคุณและนำทางไปที่ http://127.0.0.1:8000/swagger/ เพื่อดูเอกสาร API แบบโต้ตอบที่สร้างขึ้นโดย Swagger UI
เริ่มสร้างจุดสิ้นสุด API ของคุณ:
- กำหนดจุดสิ้นสุด API ของคุณใน
urls.py - ใช้มุมมองและ serializers สำหรับทรัพยากร API ของคุณใน
views.py และ serializers.py ตามลำดับ - รักษาความปลอดภัยจุดสิ้นสุดของคุณโดยใช้การตรวจสอบโทเค็นและกำหนดสิทธิ์ตามต้องการ
การทดสอบ
เรียกใช้การทดสอบหน่วยและการทดสอบการรวมเพื่อให้แน่ใจว่าความน่าเชื่อถือและความเสถียรของ API ของคุณ:
การบริจาค
ยินดีต้อนรับ! หากคุณมีคำแนะนำสำหรับการปรับปรุงหรือคุณสมบัติใหม่โปรดเปิดปัญหาหรือส่งคำขอดึง
ใบอนุญาต
โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต Apache -2.0 - ดูไฟล์ใบอนุญาตสำหรับรายละเอียด