Django REST Framework 教程项目文档

Django REST Framework 教程项目文档

Django-Rest-Framework-TutorialLearn how to build REST APIs with Django & the Django Rest Framework.项目地址:https://gitcode.com/gh_mirrors/dja/Django-Rest-Framework-Tutorial

1. 项目的目录结构及介绍

Django-Rest-Framework-Tutorial/
├── api/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── serializers.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── Django_Rest_Framework_Tutorial/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
├── manage.py
└── requirements.txt

目录结构介绍

• api/: 包含应用的主要代码，如模型、序列化器、视图和URL配置。
  • models.py: 定义应用的数据模型。
  • serializers.py: 定义数据模型的序列化器。
  • views.py: 定义API视图。
  • urls.py: 定义应用的URL路由。
• Django_Rest_Framework_Tutorial/: 项目的主配置目录。
  • settings.py: 项目的配置文件。
  • urls.py: 项目的根URL配置。
  • wsgi.py: WSGI应用的入口点。
• manage.py: Django项目的命令行工具。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

manage.py

manage.py 是Django项目的命令行工具，用于管理项目的各种操作，如启动开发服务器、创建数据库迁移、运行测试等。

python manage.py runserver

上述命令用于启动开发服务器，默认运行在 http://127.0.0.1:8000/。

3. 项目的配置文件介绍

settings.py

settings.py 是Django项目的主要配置文件，包含数据库配置、静态文件路径、中间件、应用安装等设置。

# settings.py 部分内容示例

import os

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

SECRET_KEY = 'your-secret-key'

DEBUG = True

ALLOWED_HOSTS = []

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'api',
]

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

ROOT_URLCONF = 'Django_Rest_Framework_Tutorial.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 = 'Django_Rest_Framework_Tutorial.wsgi.application'

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation

Django-Rest-Framework-TutorialLearn how to build REST APIs with Django & the Django Rest Framework.项目地址:https://gitcode.com/gh_mirrors/dja/Django-Rest-Framework-Tutorial