Django Rest Framework (DRF)：构建 RESTful API 的利器 – wiki基地

作者： /

Django Rest Framework (DRF)：构建 RESTful API 的利器

在当今互联互通的世界中，应用程序之间的通信变得前所未有的重要。无论是移动应用与后端的数据交互，单页应用 (SPA) 通过 AJAX 请求获取数据，还是不同微服务之间的内部通信，Representational State Transfer (REST) 风格的 API 都已成为主流的选择。RESTful API 以其简洁、高效、可伸缩的特性，极大地推动了现代软件架构的发展。

然而，构建高质量的 RESTful API 并非易事。它涉及到数据序列化与反序列化、请求解析、响应生成、认证授权、分页、过滤等一系列复杂任务。如果在每一个项目中都从零开始实现这些功能，无疑会耗费大量时间和精力，并且容易出错。

正是在这样的背景下，Django REST Framework (DRF) 应运而生。作为 Django 生态系统中最为强大和流行的库之一，DRF 为开发者提供了一整套用于快速构建功能丰富、健壮、高性能的 RESTful API 的工具集。它不仅仅是一个简单的库，更是一个遵循 Django 设计哲学——”约定优于配置”——的高度可定制的框架。DRF 充分利用了 Django 自身强大的 ORM、URL 路由、认证系统等基础能力，在此之上构建了 API 开发所需的各种抽象和组件。

本文将深入探讨 DRF 的核心概念、主要组件、优势以及如何利用它来构建高效的 RESTful API。

一、RESTful API 概述及其重要性

在深入 DRF 之前，有必要回顾一下 RESTful API 的核心概念。REST 是一种架构风格，由 Roy Fielding 在其博士论文中提出。它基于 HTTP 协议，强调以下几个核心约束：

  1. 客户端-服务器分离 (Client-Server): 客户端和服务器是独立的，客户端只需要知道资源的 URI，而服务器处理请求并发送响应。这种分离使得客户端和服务器可以独立演进。
  2. 无状态 (Stateless): 服务器不存储关于客户端会话的任何状态信息。每次请求都必须包含所有必要的信息，服务器完全根据请求本身来处理。这提高了 API 的可伸缩性。
  3. 缓存 (Cacheable): 响应可以被定义为可缓存或不可缓存，客户端可以重用缓存的响应，提高了性能。
  4. 统一接口 (Uniform Interface): 这是 REST 的核心特征。它包含几个子约束：
    • 资源的标识 (Identification of resources): 使用 URI 来标识资源。
    • 通过表示来操作资源 (Manipulation of resources through representations): 客户端通过获取资源的表示（如 JSON、XML）来理解其状态，并通过发送表示来修改资源状态。
    • 自描述消息 (Self-descriptive messages): 消息本身包含了足够的信息来描述如何处理它（例如，HTTP 方法、媒体类型）。
    • 超媒体作为应用状态的引擎 (Hypermedia as the Engine of Application State – HATEOAS): 服务器通过在响应中包含链接来引导客户端进行下一步操作。
  5. 分层系统 (Layered System) (可选): 客户端通常不知道它是直接连接到终端服务器还是中间层（如负载均衡器、代理）。

RESTful API 之所以如此重要，是因为它们提供了一种标准化的、易于理解和使用的方式来暴露和消费数据和服务。它们使得不同技术栈的应用之间可以方便地进行通信，是构建微服务、移动应用后端、开放平台等现代分布式系统的基石。

二、为何选择 Django REST Framework？

尽管可以在任何 Web 框架中从头开始构建 RESTful API，但 DRF 为 Django 开发者提供了巨大的便利。选择 DRF 的主要理由包括：

  1. 与 Django 紧密集成: DRF 深度集成 Django，可以直接使用 Django 的模型、权限、用户系统、ORM 等功能，无需重复造轮子。
  2. 快速开发: 提供了大量可重用的组件（如 Serializers, Generic Views, ViewSets），极大地减少了编写模板代码的工作量。通过 ModelSerializer 和 ModelViewSet，只需几行代码就能为 Django 模型生成一套完整的 CRUD (创建、读取、更新、删除) API。
  3. 强大的序列化器 (Serializers): DRF 的 Serializers 是其核心亮点之一，负责复杂数据类型（如 Django 模型实例或查询集）与原生 Python 数据类型（如字典、列表）之间的转换，以及数据的校验。这解决了 API 开发中数据格式转换和验证的痛点。
  4. 自动生成的 Browsable API: DRF 提供了一个功能齐全、美观且易于使用的 Browsable API 界面。这个界面允许开发者和客户端直接在浏览器中查看 API 的端点、发送请求、查看响应，是调试和文档编写的绝佳工具。
  5. 灵活的视图层: 支持基于函数和基于类的视图，提供了一系列通用的视图类 (Generic Views) 和视图集 (ViewSets)，可以轻松处理常见的 API 操作。
  6. 内置认证和权限: 提供了多种认证（如 Token、Session、OAuth2）和权限（如 IsAuthenticated, IsAdminUser）方案，可以方便地控制 API 的访问。
  7. 分页和过滤: 内置了多种分页和过滤后端，可以轻松实现大数据集的处理和客户端按需查询。
  8. 可定制性高: 几乎所有组件都可以被继承和重写，以满足特定的业务需求。
  9. 活跃的社区和良好的文档: DRF 拥有庞大的用户群体和活跃的社区，遇到问题很容易找到解决方案。官方文档也非常详细和全面。

总而言之，DRF 是 Django 开发者构建 RESTful API 的首选工具，它通过提供一系列高效、灵活、可重用的组件，让开发者能够专注于业务逻辑，而不是底层的基础设施。

三、DRF 的核心组件详解

DRF 的强大功能主要得益于其精心设计的各个组件。理解这些组件及其相互关系是掌握 DRF 的关键。

3.1 Serializers (序列化器)

Serializers 是 DRF 中最为核心的概念之一，它承担着两个主要职责：

  1. 序列化 (Serialization): 将复杂的 Python 数据类型（如 Django 模型实例、查询集、自定义对象）转换为可以轻松渲染为 JSON、XML 或其他媒体类型的原生 Python 数据类型（如字典、列表）。
  2. 反序列化 (Deserialization): 将解析后的原生 Python 数据（从请求体中解析出来）转换回复杂的 Python 数据类型，并在转换过程中对数据进行校验。

DRF 提供了两种主要的 Serializer 类型：

  • Serializer: 这是一个基础的序列化器类，需要手动定义每个字段，适用于序列化任意数据或执行复杂的自定义验证。
  • ModelSerializer: 这是最常用的一种序列化器，它可以自动根据 Django 模型生成字段和验证器。它类似于 Django 的 ModelForm，但用于 API 数据处理。使用 ModelSerializer 可以极大地减少定义字段的重复工作。

示例 (ModelSerializer):

假设有一个简单的 Django 模型 Product:

“`python

models.py

from django.db import models

class Product(models.Model):
name = models.CharField(max_length=100)
price = models.DecimalField(max_digits=10, decimal_places=2)
stock = models.IntegerField(default=0)

def __str__(self):
    return self.name

“`

对应的 ModelSerializer 可以这样定义：

“`python

serializers.py

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
class Meta:
model = Product
fields = ‘all‘ # 序列化模型的所有字段
# 或者指定需要包含或排除的字段
# fields = [‘id’, ‘name’, ‘price’]
# exclude = [‘stock’]

# 可以添加自定义字段或覆盖模型字段的验证逻辑
# 例えば：
# is_available = serializers.SerializerMethodField()
#
# def get_is_available(self, obj):
#     return obj.stock > 0

# 可以添加对象级别的验证
# def validate(self, data):
#     if data['price'] <= 0:
#         raise serializers.ValidationError("Price must be positive.")
#     return data

“`

序列化使用:

“`python

获取一个产品实例并序列化

product = Product.objects.get(id=1)
serializer = ProductSerializer(product)
print(serializer.data) # 输出一个字典，可以渲染为 JSON

获取多个产品实例（查询集）并序列化

products = Product.objects.all()
serializer = ProductSerializer(products, many=True) # many=True 表示处理列表
print(serializer.data) # 输出一个字典列表
“`

反序列化使用:

“`python

假设接收到以下数据

data = {‘name’: ‘Laptop’, ‘price’: 1200.00, ‘stock’: 50}

创建一个新的序列化器实例，传入数据

serializer = ProductSerializer(data=data)

校验数据

if serializer.is_valid():
# 数据有效，可以保存到数据库
instance = serializer.save()
print(f”New product created: {instance.name}”)
else:
# 数据无效，查看错误信息
print(serializer.errors)
“`

Serializers 不仅处理数据的转换，还提供了强大的验证功能。字段级别的验证（如 CharField 的 max_length）会自动应用，同时也可以通过定义 validate_field_name 方法或 validate 方法实现自定义验证逻辑。

3.2 Request 和 Response 对象

DRF 用更强大的 Request 和 Response 对象替换了 Django 原生的 HttpRequest 和 HttpResponse。

  • Request: DRF 的 Request 对象是对 Django HttpRequest 的封装，它增加了对请求数据解析的支持。通过 request.data 属性，可以方便地访问解析后的请求体数据（无论是 JSON、XML 还是表单数据），而无需关心原始格式。request.query_params 用于访问 URL 查询参数。
  • Response: DRF 的 Response 对象接受序列化后的原生 Python 数据作为输入，并根据客户端的 Accept 头部（通过内容协商）将其渲染成适当的媒体类型（如 JSON、HTML）。它还提供了一个方便的方式来设置 HTTP 状态码。

示例:

“`python
from rest_framework.response import Response
from rest_framework.decorators import api_view
from rest_framework import status

@api_view([‘GET’, ‘POST’])
def product_list(request):
“””
列出所有产品或创建一个新产品。
“””
if request.method == ‘GET’:
products = Product.objects.all()
serializer = ProductSerializer(products, many=True)
return Response(serializer.data)

elif request.method == 'POST':
    # request.data 已经解析了请求体数据
    serializer = ProductSerializer(data=request.data)
    if serializer.is_valid():
        serializer.save()
        # 返回新建资源的表示和 201 Created 状态码
        return Response(serializer.data, status=status.HTTP_201_CREATED)
    # 返回错误信息和 400 Bad Request 状态码
    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

使用 @api_view 装饰器，或者继承 APIView 类，DRF 会自动处理 Request 和 Response 的转换。

“`

3.3 Views (视图)

Views 在 DRF 中扮演着接收请求、处理业务逻辑（如数据库操作、调用序列化器）、返回响应的角色。DRF 提供了多种视图编写方式：

  1. 基于函数的视图 (Function-Based Views – FBVs): 使用 @api_view 装饰器来包装标准的 Django 函数视图。这种方式简单直接，适用于简单的场景或需要精细控制的端点。
  2. 基于类的视图 (Class-Based Views – CBVs): 继承自 APIView。这种方式更结构化，可以通过继承和重写方法来组织代码，适用于更复杂的逻辑。它提供了认证、权限、限流、解析器、渲染器等的处理能力。
  3. 通用视图 (Generic Views): DRF 提供了一系列预构建的通用视图类 (rest_framework.generics)，它们封装了常见的 API 操作（如列表、创建、详情、更新、删除）。通过简单地设置 queryset 和 serializer_class 等属性，就可以快速实现这些功能，极大地减少了样板代码。
    • ListAPIView: 只读，用于列出资源集合。
    • CreateAPIView: 只写，用于创建新资源。
    • RetrieveAPIView: 只读，用于获取单个资源详情。
    • UpdateAPIView: 只写，用于更新单个资源。
    • DestroyAPIView: 只写，用于删除单个资源。
    • 组合类，如 ListCreateAPIView (列表和创建)、RetrieveUpdateDestroyAPIView (获取、更新、删除)。

示例 (Generic Views):

“`python

views.py

from rest_framework import generics
from .models import Product
from .serializers import ProductSerializer
from rest_framework.permissions import IsAuthenticatedOrReadOnly

列出所有产品并允许创建新产品

class ProductListCreateView(generics.ListCreateAPIView):
queryset = Product.objects.all()
serializer_class = ProductSerializer
# 只有认证用户才能创建，未认证用户只能查看
permission_classes = [IsAuthenticatedOrReadOnly]

获取、更新或删除单个产品

class ProductDetailView(generics.RetrieveUpdateDestroyAPIView):
queryset = Product.objects.all()
serializer_class = ProductSerializer
permission_classes = [IsAuthenticatedOrReadOnly]
lookup_field = ‘pk’ # 默认就是 pk，可以省略

“`

  1. 视图集 (ViewSets): rest_framework.viewsets 提供了更高层次的抽象。一个 ViewSet 将一组相关的视图逻辑（如 list, create, retrieve, update, partial_update, destroy）捆绑在一个类中。ViewSets 不直接提供方法处理 HTTP 请求（如 .get(), .post()), 而是提供如 .list(), .create() 这样的行为方法。ViewSets 通常与 Routers 一起使用，由 Router 负责将 URL 映射到 ViewSet 的特定行为。
    • ViewSet: 基础类，需要手动实现行为方法。
    • GenericViewSet: 继承自 GenericAPIView，提供了通用视图的能力，但没有默认的行为实现，需要Mixin类配合。
    • ModelViewSet: 最常用的 ViewSet，继承自 GenericViewSet 并混入了 ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin，为标准的模型 CRUD 操作提供了完整的行为实现。只需设置 queryset 和 serializer_class 即可。

示例 (ModelViewSet):

“`python

views.py

from rest_framework import viewsets
from .models import Product
from .serializers import ProductSerializer
from rest_framework.permissions import IsAuthenticatedOrReadOnly

class ProductViewSet(viewsets.ModelViewSet):
“””
提供产品的 ‘list’, ‘create’, ‘retrieve’, ‘update’, ‘partial_update’, ‘destroy’ 操作。
“””
queryset = Product.objects.all()
serializer_class = ProductSerializer
permission_classes = [IsAuthenticatedOrReadOnly]
“`

ViewSets 和 Generic Views 是 DRF 提高开发效率的关键。它们封装了大量重复的逻辑，让开发者可以专注于定义资源、序列化器和权限规则。

3.4 Routers (路由)

当使用 ViewSets 时，通常会配合 Routers 来自动生成 URL 模式。这避免了为每个 ViewSet 的每个行为手动编写 URL 配置。

DRF 提供了几种 Router：

  • SimpleRouter: 提供了标准的列表和详情路由。
  • DefaultRouter: 继承自 SimpleRouter，并额外提供了根视图，显示所有 ViewSet 的列表，以及 .json 等格式后缀的支持。DefaultRouter 生成的路由更符合 RESTful 风格。

示例 (使用 DefaultRouter):

“`python

urls.py (in your app)

通常在项目的根 urls.py 中配置 Router

urls.py (in your project root)

from django.contrib import admin
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from products.views import ProductViewSet # 假设 ProductViewSet 在 products.views 中

创建一个 Router 实例

router = DefaultRouter()

注册 ViewSet

第一个参数是 URL 前缀，第二个参数是 ViewSet 类

router.register(r’products’, ProductViewSet) # 生成 /products/ 和 /products/{pk}/ 等 URL

urlpatterns = [
path(‘admin/’, admin.site.urls),
# 将 Router 生成的 URL 模式包含进来
path(‘api/’, include(router.urls)),
# 也可以包含其他应用或非 ViewSet 的 API 路由
# path(‘api/some_other_endpoint/’, some_other_view),
]
“`

使用 DefaultRouter 注册 ProductViewSet 会自动生成类似以下的 URL 模式：

  • /api/products/ (GET): ProductViewSet.list()
  • /api/products/ (POST): ProductViewSet.create()
  • /api/products/{pk}/ (GET): ProductViewSet.retrieve()
  • /api/products/{pk}/ (PUT): ProductViewSet.update()
  • /api/products/{pk}/ (PATCH): ProductViewSet.partial_update()
  • /api/products/{pk}/ (DELETE): ProductViewSet.destroy()

Router 的引入进一步简化了 URL 配置，特别是在项目中有大量资源需要通过 ViewSet 暴露 API 时。

3.5 Authentication (认证) 和 Permissions (权限)

API 的安全性至关重要。DRF 提供了强大且灵活的认证和权限系统。

  • Authentication (认证): 解决“你是谁？”的问题。当一个请求到达时，认证类负责检查请求中包含的凭据（如 Token、Session ID）并确定用户身份 (request.user)。DRF 支持多种认证方式：

    • SessionAuthentication: 基于 Django session 和 cookie 的认证，适合与传统的 Django 模板或 Browsable API 结合使用。
    • TokenAuthentication: 基于 Token 的认证，用户登录后获取一个 Token，后续请求在头部携带该 Token 进行认证，适合无状态的 API 客户端（如移动应用）。
    • BasicAuthentication: HTTP Basic Auth。
    • OAuth2Authentication: 支持 OAuth2 协议 (通常需要额外库如 django-oauth-toolkit)。
    • 可以定义自定义认证类。

  • Permissions (权限): 解决“你能做什么？”的问题。在认证通过后，权限类检查认证用户的权限，决定是否允许执行请求的操作。DRF 提供了一些内置权限类：

    • AllowAny: 允许任何用户访问（默认）。
    • IsAuthenticated: 只允许认证用户访问。
    • IsAdminUser: 只允许站点管理员访问。
    • IsAuthenticatedOrReadOnly: 只允许认证用户进行写操作 (POST, PUT, PATCH, DELETE)，未认证用户只能进行读操作 (GET, HEAD, OPTIONS)。
    • 可以定义自定义权限类，检查更复杂的条件（如对象级别的权限）。

认证和权限可以全局设置，也可以在单个视图或 ViewSet 中通过 authentication_classes 和 permission_classes 属性指定。

示例:

“`python

settings.py

REST_FRAMEWORK = {
‘DEFAULT_AUTHENTICATION_CLASSES’: [
‘rest_framework.authentication.TokenAuthentication’,
‘rest_framework.authentication.SessionAuthentication’, # 方便 Browsable API
],
‘DEFAULT_PERMISSION_CLASSES’: [
‘rest_framework.permissions.IsAuthenticated’, # 默认只允许认证用户访问
]
}

views.py

from rest_framework.permissions import IsAdminUser

class ProductViewSet(viewsets.ModelViewSet):
queryset = Product.objects.all()
serializer_class = ProductSerializer
# 覆盖全局设置，只允许管理员用户进行写操作，其他认证用户只能读
permission_classes = [IsAuthenticatedOrReadOnly | IsAdminUser] # 结合使用

# 或者针对特定 action 设置权限
# def get_permissions(self):
#     if self.action == 'create':
#         return [IsAdminUser()]
#     elif self.action in ['update', 'partial_update', 'destroy']:
#         return [IsAdminUser()]
#     return [IsAuthenticatedOrReadOnly()]

“`

3.6 Pagination (分页)

当 API 返回的数据集很大时，一次性返回所有数据会导致性能问题并浪费带宽。分页机制允许客户端一次只获取部分数据。DRF 提供了多种分页样式：

  • PageNumberPagination: 基于页码的分页（例如 /api/products/?page=2&size=10）。
  • LimitOffsetPagination: 基于偏移量和限制数的分页（例如 /api/products/?limit=10&offset=20）。
  • CursorPagination: 基于游标的分页，更适合处理大型数据集的稳定排序，并能避免 LimitOffset 可能导致的问题。

分页可以全局配置，也可以在视图或 ViewSet 中通过 pagination_class 属性指定。

示例:

“`python

settings.py

REST_FRAMEWORK = {
# … 其他设置
‘DEFAULT_PAGINATION_CLASS’: ‘rest_framework.pagination.PageNumberPagination’,
‘PAGE_SIZE’: 10 # 全局默认每页10条
}

views.py

from rest_framework.pagination import LimitOffsetPagination

class ProductListView(generics.ListAPIView):
queryset = Product.objects.all()
serializer_class = ProductSerializer
# 覆盖全局设置，该视图使用 LimitOffset 分页
pagination_class = LimitOffsetPagination
“`

3.7 Filtering (过滤) 和 Searching (搜索)

客户端通常需要根据特定条件过滤或搜索资源。DRF 提供了内置的支持，并可以与 django-filter 等第三方库无缝集成。

  • django-filter 集成: 最常用和功能最强大的过滤方式。安装 django-filter 并将其添加到 INSTALLED_APPS 后，可以在 FILTER_BACKENDS 中启用 DjangoFilterBackend，并在视图中指定 filterset_class 或 filter_fields。
  • SearchFilter: 简单的基于查询参数的搜索，可以在指定字段上进行模糊匹配。
  • OrderingFilter: 允许客户端通过查询参数指定结果的排序字段。

示例:

首先安装 django-filter: pip install django-filter

“`python

settings.py

INSTALLED_APPS = [
# … 其他应用
‘django_filters’,
‘rest_framework’,
# …
]

REST_FRAMEWORK = {
# … 其他设置
‘DEFAULT_FILTER_BACKENDS’: [
‘django_filters.rest_framework.DjangoFilterBackend’, # 启用 django-filter 后端
‘rest_framework.filters.SearchFilter’, # 启用搜索后端
‘rest_framework.filters.OrderingFilter’, # 启用排序后端
],
# …
}

views.py

from rest_framework import generics
from .models import Product
from .serializers import ProductSerializer
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework import filters

class ProductListView(generics.ListAPIView):
queryset = Product.objects.all()
serializer_class = ProductSerializer
# 显式指定过滤器后端 (如果 settings 中已经设置，这里可以省略或覆盖)
filter_backends = [DjangoFilterBackend, filters.SearchFilter, filters.OrderingFilter]
# 使用 django-filter 指定可过滤的字段
filterset_fields = [‘category’, ‘in_stock’] # 假设 Product 模型有 category 和 in_stock 字段
# 使用 SearchFilter 指定可在哪些字段上搜索
search_fields = [‘name’, ‘description’]
# 使用 OrderingFilter 指定可排序的字段
ordering_fields = [‘price’, ‘stock’, ‘name’]
# 默认排序
ordering = [‘price’]
“`

这样，客户端就可以通过 URL 查询参数进行过滤、搜索和排序，例如：

  • /api/products/?category=electronics&in_stock=true
  • /api/products/?search=laptop
  • /api/products/?ordering=-price (按价格降序排序)

3.8 Versioning (版本控制)

随着 API 的演进，可能会需要引入不兼容的变更。版本控制允许不同的客户端使用不同版本的 API。DRF 支持多种版本控制方案：

  • URLPathVersioning: 通过 URL 路径指定版本 (e.g., /api/v1/products/)。
  • NamespaceVersioning: 基于 Django URL 命名空间。
  • HostNameVersioning: 基于请求的主机名。
  • AcceptHeaderVersioning: 通过 Accept 头部指定版本 (e.g., Accept: application/json; version=1.0)。
  • QueryParameterVersioning: 通过查询参数指定版本 (e.g., /api/products/?version=1.0)。

版本控制通常在全局设置 DEFAULT_VERSIONING_CLASS 来启用。

3.9 Documentation (文档)

好的 API 文档对于消费者至关重要。DRF 可以与第三方库结合，根据代码自动生成 API 文档，如 Swagger (OpenAPI) 或 Redoc。流行的库包括 drf-yasg 和 djangorestframework-spectacular。这些库可以扫描 DRF 的视图、序列化器和路由，生成符合 OpenAPI 规范的文档，并提供交互式界面。

四、DRF 的优势总结

回顾 DRF 的核心组件，我们可以再次总结其作为构建 RESTful API 利器的主要优势：

  1. 极高的开发效率: Serializers, Generic Views, ViewSets, Routers 等组件极大地减少了样板代码，使得开发者可以快速地为模型构建出完整的 API 端点。
  2. 强大的序列化和验证: 内置的 Serializers 提供了灵活且强大的数据转换和验证机制，是 API 数据处理的基石。
  3. 内置的安全功能: 提供了多种认证和权限方案，方便实现 API 的访问控制。
  4. 完善的功能覆盖: 集成了分页、过滤、搜索、限流等 API 开发中常用的功能。
  5. 出色的开发体验: Browsable API 提供了交互式的调试和查看界面。
  6. 高度的可定制性: 大多数组件都可以继承和重写，以满足复杂的业务需求。
  7. 丰富的生态系统: 与 Django 其他库和第三方库（如 django-filter, drf-yasg, django-oauth-toolkit）结合紧密。

五、如何开始使用 DRF

开始使用 DRF 非常简单：

  1. 安装: pip install djangorestframework
  2. 添加到 INSTALLED_APPS: 在 Django 项目的 settings.py 中，将 'rest_framework' 添加到 INSTALLED_APPS 中。如果使用 Token 认证，还需要添加 'rest_framework.authtoken'。
  3. 配置 URL: 在项目的 urls.py 中，可以使用 Router 来包含 ViewSet 的 URL，或者手动为 Generic Views 或 Function Views 配置 URL。
  4. 定义 Serializers: 为需要暴露 API 的模型或其他数据定义 Serializer。
  5. 编写 Views 或 ViewSets: 实现 API 的业务逻辑。优先考虑使用 ModelSerializer 和 ModelViewSet 来提高效率。
  6. 运行开发服务器: python manage.py runserver
  7. 访问 Browsable API: 在浏览器中访问 API 端点 URL，查看 Browsable API 界面。

通过一个简单的模型、ModelSerializer 和 ModelViewSet，你可以在几分钟内搭建起一个具备 CRUD 功能的 API 端点，这充分体现了 DRF 的强大和便捷。

六、进阶与注意事项

在使用 DRF 的过程中，还有一些进阶话题和注意事项值得关注：

  • 性能优化: 对于大型应用，需要关注 API 的性能。这包括优化数据库查询（避免 N+1 查询问题，使用 select_related 和 prefetch_related）、使用分页、合理的序列化器深度等。
  • 自定义组件: 当内置组件无法满足需求时，可以自定义 Serializers、Fields、Validators、Permissions、Pagination Styles、Parsers、Renderers 等。
  • 测试: 编写 API 单元测试和集成测试非常重要。DRF 提供了 APIClient 类来方便地模拟 API 请求进行测试。
  • 错误处理: DRF 提供了标准的异常处理机制，可以自定义错误响应格式。
  • 限流 (Throttling): 可以限制客户端在一定时间内可以发起的请求次数，保护 API 免受滥用。DRF 内置了多种限流策略。

七、总结

Django REST Framework 是一个成熟、功能强大且高度灵活的库，它是 Django 开发者构建高质量 RESTful API 的不二之选。通过提供一套完整的工具和约定，DRF 极大地简化了 API 开发过程中的序列化、验证、视图逻辑、路由、认证、权限、分页等复杂任务。从快速原型开发到构建大规模、高可用的生产级 API，DRF 都能提供坚实的支持。

如果你正在使用 Django 并需要构建 API，那么投入时间学习和掌握 DRF 将是回报丰厚的投资。它将帮助你更快速、更高效、更可靠地交付 API 产品，让你能够将更多精力放在实现核心业务价值上，而不是重复造轮子。DRF 无疑是构建 RESTful API 的一把强大“利器”。

发表评论

您的邮箱地址不会被公开。 必填项已用 * 标注

滚动至顶部