django api generator

Generator API Django

Alat sederhana yang menghasilkan API aman di atas DRF dengan upaya minimum - secara aktif didukung oleh APP -generator .

• Django - Bangun Layanan Tanpa Coding - Presentasi Video

---

Untuk serangkaian fitur lengkap dan dukungan jangka panjang, periksa Dynamic Django , starter yang kuat yang menggabungkan:

• Datatables Dinamis: Menggunakan satu baris konfigurasi, data yang disimpan dalam tabel apa pun dikelola secara otomatis
• API Dinamis: Model apa pun bisa menjadi titik akhir API yang aman menggunakan DRF
• Bagan Dinamis: Ekstrak Grafik yang relevan tanpa mengkode semua jenis utama didukung
• CSV Loader: Menerjemahkan file CSV ke dalam model Django dan (opsional) memuat informasi
• Alat CLI yang kuat untuk antarmuka GIT, mengedit konfigurasi, memperbarui konfigurasi dan database (Buat model, migrasi DB)

Fitur

• API engine disediakan oleh DRF
• Diamankan oleh JWT Tokens (permintaan bermutasi)
• Minimal Configuration (baris tunggal dalam konfigurasi untuk setiap model)
• Handles any model yang didefinisikan di seluruh proyek
• Logika akses CRUD :
  • READ adalah publik (semua item, dapatkan item dengan ID)
  • Mutating requests dilindungi oleh JWT Tokens

Cara menggunakannya

Langkah #1 - Install the package

$ pip install django-api-generator
// OR
$ pip install git+https://github.com/app-generator/django-api-generator.git

Langkah #2 - Update Configuration , sertakan aplikasi baru

 INSTALLED_APPS = [
    'django_api_gen' ,            # Django API GENERATOR  # <-- NEW
    'rest_framework' ,            # Include DRF           # <-- NEW 
    'rest_framework.authtoken' ,  # Include DRF Auth      # <-- NEW   
]

Langkah #3 - Register the model dalam core/settings.py (bagian API_Generator)

Kode sampel ini mengasumsikan bahwa app1 ada dan Book model didefinisikan dan dimigrasi.

 API_GENERATOR = {
    # pattern: 
    # API_SLUG -> Import_PATH 
    'books'  : "app1.models.Book" ,
}

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES' : [
        'rest_framework.authentication.SessionAuthentication' ,
        'rest_framework.authentication.TokenAuthentication' ,
    ],
}

Langkah #4 - Migrate DB dan buat tabel yang digunakan oleh DRF

$ python manage.py makemigrations
$ python manage.py migrate

Langkah #5 - Generate API

$ python manage.py generate-api
// OR 
$ python manage.py generate-api -f # supress confirmation (forcing mode)

Kode ini dihasilkan di bawah folder api di akar proyek. Pada setiap iterasi kode API ditimpa .

Langkah #6 - Update routing , sertakan API

 from django . contrib import admin
from django . urls import path , include                        # <-- UPD: 'include` directive
from rest_framework . authtoken . views import obtain_auth_token # <-- NEW

urlpatterns = [
    path ( "admin/" , admin . site . urls ),
    path ( "api/" ,   include ( "api.urls" )),        # <-- NEW
    path ( 'login/jwt/' , view = obtain_auth_token ), # <-- NEW
]    

Langkah #7 - Use API

Jika model yang dikelola adalah Books , antarmuka API adalah /api/books/ dan semua metode CRUD tersedia.

Catatan: Untuk permintaan yang bermutasi, JWT Token disediakan oleh http://localhost:8000/login/jwt/ rute (pengguna harus ada).

Tautan & Sumber Daya

• DRF - Beranda
• Lebih banyak alat pengembang yang disediakan oleh AppSeed
• Minta dukungan melalui Email & Discord

---

Django API Generator-Perpustakaan Open-Source Disediakan oleh App-Generator