REST API 项目教程

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

REST-API/
├── README.md
├── requirements.txt
├── manage.py
├── rest_api/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   ├── wsgi.py
│   └── asgi.py
├── api/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── serializers.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
└── static/
    └── README.md

目录结构介绍

• REST-API/: 项目根目录。
  • README.md: 项目说明文件。
  • requirements.txt: 项目依赖文件。
  • manage.py: Django 项目管理文件。
  • rest_api/: Django 项目配置目录。
    • __init__.py: 包初始化文件。
    • settings.py: 项目配置文件。
    • urls.py: 项目路由配置文件。
    • wsgi.py: WSGI 服务器配置文件。
    • asgi.py: ASGI 服务器配置文件。
  • api/: API 应用目录。
    • __init__.py: 包初始化文件。
    • admin.py: Django 管理后台配置文件。
    • apps.py: 应用配置文件。
    • models.py: 数据模型文件。
    • serializers.py: 序列化器文件。
    • tests.py: 测试文件。
    • urls.py: 应用路由配置文件。
    • views.py: 视图文件。
  • static/: 静态文件目录。
    • README.md: 静态文件说明文件。

2. 项目的启动文件介绍

manage.py

manage.py 是 Django 项目的主要管理文件，用于执行各种管理命令，如运行开发服务器、创建数据库迁移、应用数据库迁移等。

python manage.py runserver  # 启动开发服务器
python manage.py makemigrations  # 创建数据库迁移
python manage.py migrate  # 应用数据库迁移

wsgi.py 和 asgi.py

• wsgi.py: 用于部署 WSGI 服务器，如 Gunicorn 或 uWSGI。
• asgi.py: 用于部署 ASGI 服务器，如 Daphne 或 Uvicorn。

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 = 'rest_api.urls'

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