django api generator

Django API -Generator

Einfaches Tool, das sich mit minimalem Aufwand auf sichere APIs über DRF erzeugt - aktiv unterstützt von App -Generator .

• Django - Build Services ohne Codierung - Videopräsentation

---

Eine vollständige Anzahl von Funktionen und langfristigen Unterstützung finden Sie in Dynamic Django , einem leistungsstarken Starter, der enthält:

• Dynamische DataTables: Verwenden einer einzelnen Konfigurationszeile werden die in einer beliebigen Tabelle gespeicherten Daten automatisch verwaltet
• Dynamische API: Jedes Modell kann mit DRF zu einem sicheren API -Endpunkt werden
• Dynamische Diagramme: Relevante Diagramme extrahieren, ohne alle Haupttypen zu codieren, werden unterstützt
• CSV Loader: Übersetzen Sie CSV -Dateien in Django -Modelle und (optional) die Informationen laden Sie
• Leistungsstarke CLI -Tools für die GIT -Schnittstelle, Konfigurationsbearbeitung, Aktualisierung der Konfiguration und Datenbank (Modelle erstellen, migrieren DB)

Merkmale

• API engine von DRF bereitgestellt
• Von JWT Tokens gesichert (Mutationsanfragen)
• Minimal Configuration (Einzelzeile in der Konfiguration für jedes Modell)
• Handles any model , das über das Projekt definiert ist
• CRUD Access Logic:
  • READ ist öffentlich (alle Artikel, Element mit ID)
  • Mutating requests werden von JWT Tokens geschützt

Wie man es benutzt

Schritt 1 - Install the package

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

Schritt 2 - Update Configuration die neuen Apps

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

Schritt Nr. 3 - Register the model in core/settings.py (API_GENERATOR -Abschnitt).

Dieser Beispielcode geht davon aus, dass app1 existiert und das Book definiert und migriert wird.

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

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

Schritt Nr. 4 - Migrate DB und erstellen Sie die von DRF verwendeten Tabellen

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

Schritt 5 - Generate API

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

Der Code wird unter dem api -Ordner im Stammwurzel des Projekts generiert. Bei jeder Iteration wird der API -Code überschrieben .

Schritt Nr. 6 - Update routing , APIs enthalten

 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
]    

Schritt Nr. 7 - Use API

Wenn das verwaltete Modell Books ist, ist die API -Schnittstelle /api/books/ und alle Crud -Methoden sind verfügbar.

Hinweis: Für Mutationsanforderungen wird das JWT Token von http://localhost:8000/login/jwt/ Route bereitgestellt (der Benutzer sollte existieren).

Links und Ressourcen

• DRF - Homepage
• Weitere Entwickler -Tools von AppSeed
• Bitten Sie um Unterstützung per Email und Discord

---

Django API-Generator-Open-Source-Bibliothek von App-Generator bereitgestellt