Configuration du projet API Django

Qu’attendre de cet article ?

Eh bien, commençons à coder ! c'est le premier article de codage après avoir présenté l'idée d'Alive Diary et prouvé que Gemini peut être l'âme, nous allons commencer à coder le Backend avec Django.
Pour garder les choses en ordre, je discuterai du projet à travers plusieurs articles, donc cet article

• couvrira le processus de configuration du projet.
• présentera les bibliothèques utilisées et pourquoi nous les utilisons.
• créera les applications et expliquera la logique qui les sous-tend.

Je vais essayer de couvrir autant de détails que possible sans vous ennuyer, mais j'attends quand même que vous soyez familier avec certains aspects de Python et Django.

la version finale du code source peut être trouvée sur https://github.com/saad4software/alive-diary-backend

Ordre de série

Consultez les articles précédents si vous êtes intéressé !

1. Projet IA à partir de zéro, The Idea, Alive Diary
2. Prouvez que c'est faisable avec Google AI Studio
3. Configuration du projet API Django (Vous êtes ici ?)

Commencez le projet !

Après avoir installé Python et configuré un environnement virtuel adapté à votre système d'exploitation. assurez-vous d'installer ces bibliothèques

Django==4.2.16          # it is django itself!
django-cors-headers==4.4.0  # avoid cors-headers issues
django-filter==24.3     # easily filter text fields 
djangorestframework==3.15.2 # rest framework!
djangorestframework-simplejwt==5.3.1    # JWT token
pillow==10.4.0          # for images
python-dotenv==1.0.1        # load config from .env file
google-generativeai==0.7.2  # google api
ipython==8.18.1         # process gemini responses
django-parler==2.3              # multiple languages support
django-parler-rest==2.2         # multi-language with restframework

requirements.txt

Il n'est pas nécessaire que ce soit la même version, selon votre version de Python, vous pouvez installer chacune d'elles manuellement en utilisant

pip installer Django

ou créez le fichier d'exigences et utilisez le même ancien

pip install -r exigences.txt

Avec Django et les librairies installées, nous pouvons démarrer notre projet

django-admin startproject alive_diary
cd alive_diary
python manage.py startapp app_account
python manage.py startapp app_admin
python manage.py startapp app_main

Nous avons créé un projet appelé "alive_diary" et à l'intérieur de celui-ci, nous avons créé trois applications,

• app_account : pour gérer les données essentielles du compte des utilisateurs, l'enregistrement, la connexion, la modification du mot de passe, la vérification de l'e-mail du compte et des responsabilités similaires.
• app_admin : pour les tâches liées à l'administration, principalement la gestion des utilisateurs pour cette application simple
• app_main : pour l'application principale.

Nous conserverons une dépendance minimale entre les applications Django pour les rendre réutilisables dans d'autres projets.

Paramètres

En bref, c'est le fichier de paramètres final, parcourons-le rapidement

import os
from datetime import timedelta
from pathlib import Path
from dotenv import load_dotenv

Nous avons utilisé timedelta du package datetime pour définir la durée de vie de JWT, os et load_dotenv pour charger les variables à partir du fichier .env.

load_dotenv()

charger les variables à partir du fichier .env

BASE_DIR = Path(__file__).resolve().parent.parent
SECRET_KEY = os.getenv("SECRET_KEY")
DEBUG = True
ALLOWED_HOSTS = ['*']

ajout de '*' pour ALLOWED_HOSTS pour permettre la connexion à partir de n'importe quelle IP. os.getenv récupère la valeur clé du fichier .env.

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'corsheaders',
    'rest_framework',
    'django_filters',
    'app_account',
    'app_admin',
    'app_main',
]

Ajout des applications corsheaders, rest_framework et django_filters, ainsi que de nos trois applications, app_account, app_admin et app_main.

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

N'oubliez pas d'ajouter le middleware CorsMiddleware avant le CommonMiddleware

Django==4.2.16          # it is django itself!
django-cors-headers==4.4.0  # avoid cors-headers issues
django-filter==24.3     # easily filter text fields 
djangorestframework==3.15.2 # rest framework!
djangorestframework-simplejwt==5.3.1    # JWT token
pillow==10.4.0          # for images
python-dotenv==1.0.1        # load config from .env file
google-generativeai==0.7.2  # google api
ipython==8.18.1         # process gemini responses
django-parler==2.3              # multiple languages support
django-parler-rest==2.2         # multi-language with restframework

ajout de la configuration des en-têtes cors au fichier de paramètres

django-admin startproject alive_diary
cd alive_diary
python manage.py startapp app_account
python manage.py startapp app_admin
python manage.py startapp app_main

Utilisez l'authentification JWT simple comme classe d'authentification par défaut pour la bibliothèque de framework Rest.

import os
from datetime import timedelta
from pathlib import Path
from dotenv import load_dotenv

remplacez la classe d'utilisateurs par défaut par une classe personnalisée à partir de app_account, nous n'avons pas encore créé ce modèle.

load_dotenv()

Ajout des langues prises en charge et définition de dossiers pour les fichiers et les statistiques

BASE_DIR = Path(__file__).resolve().parent.parent
SECRET_KEY = os.getenv("SECRET_KEY")
DEBUG = True
ALLOWED_HOSTS = ['*']

Paramètres de messagerie, pour le processus de vérification des e-mails. nous les chargeons à partir du fichier .env.

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'corsheaders',
    'rest_framework',
    'django_filters',
    'app_account',
    'app_admin',
    'app_main',
]

Paramètres simples du jeton JWT, nous définissons la durée de vie du jeton d'accès "ACCESS_TOKEN_LIFETIME" sur 8 heures et la durée de vie du jeton d'actualisation "REFRESH_TOKEN_LIFETIME" sur 5 jours. nous faisons tourner le jeton d'actualisation (en envoyant un nouveau jeton d'actualisation à chaque demande de jeton d'actualisation) "ROTATE_REFRESH_TOKENS" et utilisons le préfixe d'en-tête 'Bearer' pour l'authentification "AUTH_HEADER_TYPES".

Le dossier d'environnement

Les variables utilisées dans le fichier .env doivent être

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

définissez les valeurs en fonction de votre projet, vous pouvez utiliser la clé secrète Django générée pour Secret Key, obtenir la clé API Google Gemini d'AI Studio et utiliser votre compte de messagerie pour les e-mails de vérification.
utiliser un compte Google pour envoyer des e-mails est possible, mais non recommandé. les paramètres devraient être comme

ROOT_URLCONF = 'alive_diary.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

WSGI_APPLICATION = 'alive_diary.wsgi.application'

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}


AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

STATIC_URL = '/static/'

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

# CORS HEADERS
CORS_ORIGIN_ALLOW_ALL = True
CORS_ALLOW_CREDENTIALS = True

et l'utilisateur doit activer « Applications moins sécurisées » pour accéder au compte Gmail. de toute façon, nous pouvons d’abord construire le tout et nous en préoccuper plus tard. ignorez simplement la partie vérification des e-mails pour le moment.

Conclure

Juste pour pouvoir exécuter le projet et terminer cet article, créons un modèle utilisateur dans app_account/models.py

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ],
}

aussi simple que ça ! (nous allons y travailler dans le prochain article) faisons des migrations et migrons

AUTH_USER_MODEL = 'app_account.User'

Si tout s'est bien passé, vous devriez pouvoir lancer le projet maintenant d'ici

LANGUAGES = [
    ('en', 'English'),
    ('ar', 'Arabic')
]

STATICFILES_DIRS = [os.path.join(BASE_DIR, "app_main", "site_static")]
STATIC_ROOT = os.path.join(BASE_DIR, "app_main", "static")
MEDIA_ROOT = os.path.join(BASE_DIR, "app_main", "media")
MEDIA_URL = "/app_main/media/"

Veuillez partager avec moi tout problème que vous avez rencontré. Nous sommes prêts à commencer à travailler sur les applications du projet maintenant !

Et c'est tout !

Le prochain article devrait couvrir app_account, l'application de gestion des utilisateurs, il comprend la gestion des utilisateurs, la connexion, l'enregistrement, la modification du mot de passe, l'oubli du mot de passe, la vérification du compte et d'autres actions liées aux utilisateurs dont nous avons besoin dans la plupart des applications.

Rester à l'écoute ?

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!