Django新手项目从创建到运行项目

Django新手项目从创建到运行项目

步骤 1：创建Django项目

首先，确保你已经安装了Django和Django REST framework。如果没有，请使用以下命令安装：

pip install django djangorestframework

然后，创建一个Django项目：

django-admin startproject api_project

步骤 2：创建Django应用程序

在项目目录中，创建一个Django应用程序

cd api_project
python manage.py startapp api

步骤 3：定义模型

在api/models.py文件中定义一个模型。这里，我们将创建一个简单的模型表示"任务"，每个任务有一个标题和一个描述：

from django.db import models

class Task(models.Model):
    title = models.CharField(max_length=200)
    description = models.TextField()

步骤 4：创建序列化器

创建一个Django REST framework的序列化器来将模型转化为JSON格式：

在api/serializers.py中：

from rest_framework import serializers
from .models import Task

class TaskSerializer(serializers.ModelSerializer):
    class Meta:
        model = Task
        fields = '__all__'

步骤 5：创建API视图

创建一个视图来处理API请求：

在api/views.py中：

from rest_framework import generics
from .models import Task
from .serializers import TaskSerializer

class TaskListCreateView(generics.ListCreateAPIView):
    queryset = Task.objects.all()
    serializer_class = TaskSerializer

步骤 6：定义API URL

在api/urls.py中定义API端点的URL：

from django.urls import path
from .views import TaskListCreateView

urlpatterns = [
    path('tasks/', TaskListCreateView.as_view(), name='task-list-create'),
]

步骤 7：运行迁移和启动Django开发服务器

运行数据库迁移以创建表：

python manage.py makemigrations
python manage.py migrate

然后，运行Django开发服务器：

python manage.py runserver

步骤 8：创建API文档

你可以使用Django REST framework的内置功能生成API文档。首先，在api_project/settings.py中，确保’rest_framework’和’rest_framework.authtoken’应用程序已经添加到INSTALLED_APPS中。

然后，在api_project/urls.py中，将Django REST framework的URL路由器添加到项目URL配置中：

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('api.urls')),
]

步骤 9：运行项目

运行Django开发服务器，并访问API文档：

python manage.py runserver

API文档通常位于http://localhost:8000/api/，你可以在那里查看和测试你的API端点。