django rest starter kit

Django Rest Framework Starter Kit

Ini adalah templat pemula untuk proyek Django Rest Framework (DRF), yang dirancang untuk memberikan fondasi yang kuat dengan fitur -fitur penting yang umum dibutuhkan dalam pengembangan API.

Fitur

• Otentikasi Berbasis Token : Amankan titik akhir API Anda menggunakan otentikasi berbasis token.
• Dokumentasi API Swagger : Secara otomatis menghasilkan dokumentasi API interaktif menggunakan Swagger UI.
• Sistem Manajemen Pengguna : Menerapkan fungsi pendaftaran pengguna, login, logout, dan reset kata sandi.
• Izin dan Peran : Tentukan peran dan izin pengguna untuk mengontrol akses ke titik akhir API.
• Pemberitahuan Email : Mengatur pemberitahuan email untuk acara terkait pengguna seperti pendaftaran dan reset kata sandi.
• Pembatasan Tingkat : Mencegah penyalahgunaan titik akhir API dengan menerapkan pembatasan tingkat.
• Upload file : Dukungan mengunggah file (misalnya, gambar, dokumen) dengan backend penyimpanan yang dapat disesuaikan.
• Caching : Meningkatkan kinerja API dengan caching untuk data yang sering diakses.
• Tugas Latar Belakang : Lakukan tugas latar belakang secara tidak sinkron menggunakan seledri dan broker pesan.
• Pemantauan dan Penebangan : Pantau kinerja aplikasi dan lacak kesalahan dengan alat logging dan pemantauan.

Penggunaan

1. Klon Repositori ini:

   git clone https://github.com/hossainchisty/django-rest-starter-kit.git

2. Instal dependensi:

   pip install -r requirements.txt

3. Kustomisasi Pengaturan:

   • Konfigurasikan Pengaturan Basis Data di settings.py .
   • Mengatur konfigurasi email untuk mengirim pemberitahuan.
   • Konfigurasikan pengaturan otentikasi token.
   • Kustomisasi izin dan peran sesuai dengan persyaratan aplikasi Anda.

4. Migrasi database:

   python manage.py migrate

5. Jalankan server pengembangan:

   python manage.py runserver

6. Akses dokumentasi API:

   Buka browser Anda dan navigasikan ke http://127.0.0.1:8000/swagger/ untuk melihat dokumentasi API interaktif yang dihasilkan oleh Swagger UI.

7. Mulailah membangun titik akhir API Anda:

   • Tentukan titik akhir API Anda di urls.py
   • Menerapkan tampilan dan serializer untuk sumber daya API Anda di views.py dan serializers.py masing -masing.
   • Amankan titik akhir Anda menggunakan otentikasi token dan tentukan izin sesuai kebutuhan.

Pengujian

Jalankan tes unit dan tes integrasi untuk memastikan keandalan dan stabilitas API Anda:

python manage.py test 

Berkontribusi

Kontribusi dipersilakan! Jika Anda memiliki saran untuk perbaikan atau fitur baru, silakan buka masalah atau kirimkan permintaan tarik.

Lisensi

Proyek ini dilisensikan di bawah lisensi APACHE -2.0 - lihat file lisensi untuk detailnya.