django之DRF框架搭建API项目的步骤

1. 创建虚拟环境并安装必要的包

参考：python虚拟环境

2. 创建 Django 项目和应用

django-admin startproject myproject
cd myproject
python manage.py startapp myapp

3. 在 settings.py 中进行基础配置

NSTALLED_APPS = [
    # ... 现有应用 ...
    'rest_framework',
    'myapp',
]

# DRF 配置
REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.BasicAuthentication'
    ],
}

4. 创建模型

根据需要自行创建

from django.db import models

class Item(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.name

5. 创建模型的序列化器

from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
    class Meta:
        model = Item
        fields = '__all__'

6. 创建视图

from rest_framework import viewsets
from .models import Item
from .serializers import ItemSerializer

class ItemViewSet(viewsets.ModelViewSet):
    queryset = Item.objects.all()
    serializer_class = ItemSerializer

7. 配置URL

from django.contrib import admin
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from myapp.views import ItemViewSet

router = DefaultRouter()
router.register(r'items', ItemViewSet)

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

8. 进行数据库迁移

python manage.py makemigrations
python manage.py migrate

9. 运行开发服务器

python manage.py runserver

主要注意事项：

1. 确保在 settings.py 中正确配置数据库连接
2. 根据需要添加适当的权限控制
3. 可以根据需求自定义序列化器和视图
4. 建议添加适当的文档（可以使用 drf-yasg 或 drf-spectacular）
5. 考虑添加测试用例

访问地址：

• API 根目录：http://localhost:8000/api/
• 管理后台：http://localhost:8000/admin/