>  기사  >  백엔드 개발  >  Django API 프로젝트 설정

Django API 프로젝트 설정

Mary-Kate Olsen
Mary-Kate Olsen원래의
2024-10-28 19:04:29752검색

Django API Project Setup

이 기사에서 무엇을 기대할 수 있습니까?

자, 코딩을 시작해 볼까요! Alive Diary의 아이디어를 소개하고 Gemini가 영혼이 될 수 있다는 것을 증명한 후 첫 번째 코딩 글입니다. 이제 Django를 사용하여 백엔드 코딩을 시작하겠습니다.
상황을 정리하기 위해 여러 기사를 통해 프로젝트에 대해 논의할 예정이므로 이 기사

  • 프로젝트 설정 과정을 다루겠습니다.
  • 사용된 라이브러리와 이를 사용하는 이유를 소개합니다.
  • 앱을 만들고 그 뒤에 있는 논리를 설명합니다.

지루하지 않게 최대한 많은 세부 사항을 다루도록 노력하겠습니다. 하지만 여전히 Python과 Django의 일부 측면에 익숙하실 것으로 기대합니다.

소스코드의 최종 버전은 https://github.com/saad4software/alive-diary-backend에서 확인하실 수 있습니다

시리즈 순서

관심 있으신 분들은 이전 글을 확인해보세요!

  1. 처음부터 AI 프로젝트, 아이디어, 살아 있는 일기
  2. Google AI Studio로 실현 가능함을 증명하세요
  3. Django API 프로젝트 설정(현재 위치 ?)

프로젝트를 시작하세요!

Python을 설치하고 운영체제에 맞는 가상 환경을 설정한 후. 해당 라이브러리를 설치하세요

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

동일한 버전일 필요는 없지만 Python 버전에 따라 다음을 사용하여 각 버전을 수동으로 설치할 수 있습니다.

pip install django

또는 요구사항 파일을 생성하고 동일한 이전 버전을 사용하세요

pip install -r 요구사항.txt

django와 라이브러리가 설치되면 프로젝트를 시작할 수 있습니다

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

'alive_diary'라는 프로젝트를 만들고 그 안에 3개의 앱을 만들었습니다.

  • app_account: 사용자의 필수 계정 정보, 등록, 로그인, 비밀번호 변경, 계정 이메일 확인 및 유사한 책임을 관리합니다.
  • app_admin: 관리자 관련 작업을 위해 주로 이 간단한 앱의 사용자를 관리합니다
  • app_main: 메인 앱용

Django 앱을 다른 프로젝트에서 재사용할 수 있도록 최소한의 종속성을 유지할 것입니다.

설정

요컨대 이것이 최종 설정 파일이므로 빠르게 살펴보겠습니다

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

datetime 패키지의 timedelta를 사용하여 JWT 수명을 설정하고, os 및 load_dotenv를 사용하여 .env 파일에서 변수를 로드했습니다.

load_dotenv()

.env 파일에서 변수 로드

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

모든 IP로부터의 연결을 허용하기 위해 ALLOWED_HOSTS에 '*'를 추가했습니다. os.getenv는 .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',
]

corsheaders, Rest_framework 및 django_filters 앱과 세 가지 앱인 app_account, app_admin 및 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',
]

CommonMiddleware 앞에 CorsMiddleware 미들웨어를 추가하는 것을 잊지 마세요

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

설정 파일에 cors 헤더 구성 추가

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

Simple JWT 인증을 나머지 프레임워크 라이브러리의 기본 인증 클래스로 사용하세요.

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

기본 사용자 클래스를 app_account에서 사용자 정의 클래스로 변경했지만 아직 이 모델을 만들지 않았습니다.

load_dotenv()

지원 언어를 추가하고 파일 및 정적 폴더를 설정했습니다

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

이메일 확인 절차를 위한 이메일 설정입니다. .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',
]

간단한 JWT 토큰 설정, 액세스 토큰 "ACCESS_TOKEN_LIFETIME"의 수명을 8시간으로 설정하고 새로 고침 토큰 수명 "REFRESH_TOKEN_LIFETIME"을 5일로 설정합니다. 새로 고침 토큰을 순환하고(모든 새로 고침 토큰 요청과 함께 새 새로 고침 토큰 전송) "ROTATE_REFRESH_TOKENS"를 사용하고 인증을 위해 'Bearer' 헤더 접두사 "AUTH_HEADER_TYPES"를 사용하고 있습니다.

환경 파일

.env 파일에서 사용되는 변수는 다음과 같아야 합니다

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',
]

프로젝트에 따라 값을 설정하면 생성된 django 비밀 키를 비밀 키로 사용할 수 있고, AI 스튜디오에서 Google Gemini API 키를 받고, 확인 이메일에 이메일 계정을 사용할 수 있습니다.
Google 계정을 사용하여 이메일을 보내는 것은 가능하지만 권장되지 않습니다. 설정은 다음과 같아야 합니다

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

사용자는 Gmail 계정에 액세스하려면 '보안 수준이 낮은 앱'을 활성화해야 합니다. 어쨌든 우리는 먼저 모든 것을 구축하고 나중에 걱정할 수 있습니다. 지금은 이메일 확인 부분을 무시하세요.

끝내다

프로젝트를 실행하고 이 기사를 마무리하기 위해 app_account/models.py에서 사용자 모델을 생성해 보겠습니다

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

그렇게 간단합니다! (다음 글에서 작업할 예정입니다.) 마이그레이션을 진행하고 마이그레이션해 봅시다

AUTH_USER_MODEL = 'app_account.User'

모든 것이 순조롭게 진행되었다면 이제
까지 프로젝트를 실행할 수 있을 것입니다.

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/"

어떤 문제든 저에게 알려주세요. 이제 프로젝트 앱 작업을 시작할 준비가 되었습니다!

그리고 그게 다야!

다음 기사에서는 사용자 관리 앱인 app_account에 대해 다루겠습니다. 여기에는 사용자 관리, 로그인, 등록, 비밀번호 변경, 비밀번호 찾기, 계정 확인 및 대부분의 앱에 필요한 기타 사용자 관련 작업이 포함되어 있습니다.

기대해 주세요 ?

위 내용은 Django API 프로젝트 설정의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.