DRF 使用APIView编写第一个DRF API的完整教程

本教程将手把手教你用Django REST Framework的APIView类创建第一个RESTful API，涵盖从环境搭建到接口测试的全流程。

一、环境准备

1.1 创建Django项目

# 创建项目目录
mkdir myapi && cd myapi

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows

# 安装依赖
pip install django djangorestframework

# 初始化项目
13 django startproject django-rebort

*备注：

　　1、如果本地安装了django，但项目初始化时报找不到 django-admin 模块，那就更换命令为：django startproject django-rebort

　　2、使用pycharm创建django项目(社区版无此功能)，https://blog.csdn.net/m0_67402026/article/details/126113879

1.2 配置DRF

# core/settings.py
INSTALLED_APPS = [
    ...
    'rest_framework',  # 新增DRF
]

 二、创建书籍管理API

2.1 定义数据模型

# 创建新应用
python manage.py startapp books

# books/models.py
from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=200)
    author = models.CharField(max_length=100)
    published_date = models.DateField()

    def __str__(self):
        return self.title

2.2 数据库迁移

python manage.py makemigrations
python manage.py migrate

三、创建序列化器

3.1 序列化器类

# books/serializers.py
from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id', 'title', 'author', 'published_date']

四、编写APIView视图

4.1 实现CRUD操作

# books/views.py
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from .models import Book
from .serializers import BookSerializer

class BookListCreateAPIView(APIView):
    """
    处理GET(列表)和POST(创建)请求
    """
    def get(self, request):
        books = Book.objects.all()
        serializer = BookSerializer(books, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = BookSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, 
                          status=status.HTTP_201_CREATED)
        return Response(serializer.errors,
                      status=status.HTTP_400_BAD_REQUEST)

class BookDetailAPIView(APIView):
    """
    处理GET(详情)/PUT(更新)/DELETE(删除)
    """
    def get_object(self, pk):
        try:
            return Book.objects.get(pk=pk)
        except Book.DoesNotExist:
            return None

    def get(self, request, pk):
        book = self.get_object(pk)
        if not book:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookSerializer(book)
        return Response(serializer.data)

    def put(self, request, pk):
        book = self.get_object(pk)
        if not book:
            return Response(status=status.HTTP_404_NOT_FOUND)
        
        serializer = BookSerializer(book, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors,
                      status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk):
        book = self.get_object(pk)
        if not book:
            return Response(status=status.HTTP_404_NOT_FOUND)
        book.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

五、配置路由

5.1 URL映射

# core/urls.py
from django.urls import path
from books import views

urlpatterns = [
    # 书籍列表和创建
    path('books/', views.BookListCreateAPIView.as_view()),
    
    # 单个书籍操作
    path('books/<int:pk>/', views.BookDetailAPIView.as_view()),
]

六、测试API接口

6.1 使用Django Shell创建测试数据

python manage.py shell
>>> from books.models import Book
>>> Book.objects.create(title="Python编程", author="Guido", published_date="2023-01-01")

具体执行结果如下

 6.2 启动服务

python manage.py runserver

6.3 通过curl测试接口

# 获取书籍列表
curl http://127.0.0.1:8000/books/

# 创建新书籍
curl -X POST -H "Content-Type: application/json" \
-d '{"title":"DRF指南","author":"Tom","published_date":"2023-06-01"}' \
http://127.0.0.1:8000/books/

# 更新书籍
curl -X PUT -H "Content-Type: application/json" \
-d '{"title":"DRF高级指南"}' \
http://127.0.0.1:8000/books/2/

6.3 浏览器访问API 

访问 http://localhost:8000/books/ 即可看到Web界面

七、APIView核心机制解析

7.1 请求处理流程

​​请求接收​​：APIView 继承自Django 的View类
​​方法分发​​：通过 HTTP 方法名称（get/post/put等）自动路由
​​请求解析​​：自动将JSON/form-data转换为 Python 字典
响应渲染​​：自动将 Python 对象转换为 JSON 格式

7.2 与 Django View 的关键区别

特性	Django View	DRF APIView
请求解析	需手动处理request.POST	自动解析JSON/表单数据
响应格式	需手动返回HttpResponse	自动渲染为JSON
异常处理	需自定义错误响应	内置统一异常处理
认证/权限	需手动实现	提供装饰器配置

八、最佳实践建议

1. ​​保持视图简洁​​：将业务逻辑移到 service 层
2. ​​添加分页支持​​：使用 PageNumberPagination

from rest_framework.pagination import PageNumberPagination

class BookListCreateAPIView(APIView):
    def get(self, request):
        books = Book.objects.all()
        paginator = PageNumberPagination()
        page = paginator.paginate_queryset(books, request)
        serializer = BookSerializer(page, many=True)
        return paginator.get_paginated_response(serializer.data)

3. ​​添加版本控制​​：在 URL 或 header 中指定 API 版本
4. 通过本教程，您已经掌握了使用 APIView 创建基础 API 的核心技能。