django api generator

Générateur API DJANGO

Un outil simple qui génère des API sécurisées au-dessus de DRF avec un minimum d'effort - activement pris en charge par l'application-générateur .

• Django - Créer des services sans codage - présentation vidéo

---

Pour un ensemble complet de fonctionnalités et un support à long terme, consultez Dynamic Django , un démarreur puissant qui incorpore:

• Dynamique dataTables: en utilisant une seule ligne de configuration, les données enregistrées dans n'importe quel tableau sont automatiquement gérées
• API dynamique: tout modèle peut devenir un point de terminaison API sécurisé à l'aide de DRF
• Tableaux dynamiques: extraire les graphiques pertinents sans codage tous les principaux types sont pris en charge
• Chargeur CSV: traduire les fichiers CSV en modèles Django et (facultatif) Chargez les informations
• Outils CLI puissants pour l'interface GIT, l'édition de configuration, la mise à jour de la configuration et de la base de données (créer des modèles, migrer db)

Caractéristiques

• API engine fourni par DRF
• Sécurisé par JWT Tokens (demandes de mutation)
• Minimal Configuration (ligne unique en configuration pour chaque modèle)
• Handles any model défini à travers le projet
• CRUD Access Logic:
  • READ est public (tous les articles, obtenez un article par id)
  • Mutating requests sont protégées par JWT Tokens

Comment l'utiliser

Étape n ° 1 - Install the package

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

Étape n ° 2 - Update Configuration , incluez les nouvelles applications

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

Étape # 3 - Register the model dans core/settings.py (section API_GENERATOR)

Cet exemple de code suppose que app1 existe et que Book de modèle est défini et migré.

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

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

Étape n ° 4 - Migrate DB et créez les tables utilisées par DRF

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

Étape # 5 - Generate API

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

Le code est généré dans le dossier api à la racine du projet. À chaque itération, le code API est écrasé .

Étape # 6 - Update routing , incluez les 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
]    

Étape # 7 - Use API

Si le modèle géré est Books , l'interface API est /api/books/ et toutes les méthodes CRUD sont disponibles.

Remarque: Pour les demandes de mutation, le JWT Token est fourni par http://localhost:8000/login/jwt/ route (l'utilisateur doit exister).

Liens et ressources

• DRF - page d'accueil
• Plus d'outils de développeur fourni par AppSeed
• Demandez l'assistance par Email et Discord

---

Générateur API DJANGO - Bibliothèque open source fournie par l'application Générateur