揭开 RESTful API 开发利器：深入了解 Django REST Framework (DRF)

在当今互联网时代，应用程序不再是孤立的单体巨石。移动应用、单页应用 (SPA)、物联网设备、微服务架构以及与其他第三方服务的集成，都强烈依赖于应用程序之间高效、标准化的通信方式。而 Web API（特别是遵循 REST 架构风格的 API）正是实现这一目标的基石。

对于使用 Python 和 Django 构建 Web 应用的开发者来说，如何快速、高效、安全地构建功能强大的 RESTful API 一直是一个重要的课题。直接使用 Django 原生功能构建 API 固然可行，但需要手动处理序列化、反序列化、验证、请求解析、响应格式化、权限控制、认证等大量繁琐且重复的工作。这不仅耗时耗力，还容易出错，难以保证一致性和健壮性。

正是在这样的背景下，Django REST Framework (DRF) 应运而生。

什么是 Django REST Framework (DRF)?

简单来说，Django REST Framework (DRF) 是一个强大且灵活的工具包，用于帮助 Django 开发者轻松构建 Web API。它构建在 Django 之上，充分利用了 Django 的 ORM、URLs 系统、视图系统等核心功能，并在此基础上提供了大量用于构建 RESTful API 的抽象和工具。

它不是从零开始构建一个 API 框架，而是增强和扩展了 Django 的能力，使其原生支持构建符合 REST 原则的 API。你可以将其视为 Django 的一个高级插件或子框架，专门用于处理与 API 相关的一切事务。

DRF 的目标是让 API 开发变得像使用 Django 构建传统 Web 应用一样快捷和愉快。它提供了一系列开箱即用的组件，极大地减少了重复劳动，提高了开发效率和 API 的质量。

为什么选择 Django REST Framework (DRF)?

了解 DRF 是什么之后，更重要的是理解 为什么 要使用它。以下是 DRF 的主要优势和它解决的问题：

大幅提高开发效率： 这是 DRF 最核心的价值。它提供了 Serializers、Views、ViewSets、Routers 等高级抽象，让你可以用更少的代码实现复杂的功能。例如，只需几行代码就能定义模型的序列化规则，并使用通用视图或视图集快速实现模型的 CRUD (创建、读取、更新、删除) API 接口。
强大的序列化和反序列化功能： DRF 提供了一流的 Serializers，能够轻松地将 Django 模型或其他数据结构转换为 JSON、XML 等格式，反之亦然。同时，Serializers 还内置了强大的数据验证功能，确保接收到的数据符合预期，极大地简化了数据处理和校验的逻辑。
丰富的视图和视图集： DRF 提供了 APIView 作为基础，并在此之上构建了 GenericAPIView 和一系列 Mixins，用于快速实现常见的列表、详情、创建、更新、删除等操作。ViewSet 更进一步，将一组相关的操作（如 CRUD）封装到一个类中，配合 Routers 可以自动生成 URL 路由，让代码更加组织化和 DRY (Don’t Repeat Yourself)。
内置认证和权限系统： 安全是 API 的重中之重。DRF 提供了多种认证方式 (如 Token 认证、Session 认证、Basic 认证等) 和灵活的权限控制类 (如 IsAuthenticated、IsAdminUser、IsAuthenticatedOrReadOnly 等)。你可以轻松地在视图中应用这些策略，控制谁可以访问哪些资源和执行哪些操作。
自动生成的 Browsable API： 这是一个非常人性化的特性。在开发和测试阶段，DRF 可以自动生成一个可浏览的 Web 界面，展示你的 API 端点、可用的 HTTP 方法、接受的参数等信息。你甚至可以直接在这个界面上发送请求、查看响应，极大地提高了调试效率。
良好的文档和社区支持： DRF 拥有详尽的官方文档和庞大的开发者社区。遇到问题时，通常都能快速找到解决方案或获得帮助。
可定制性强： 尽管提供了许多开箱即用的组件，但 DRF 的设计非常模块化和灵活。你可以轻松地定制 Serializers、Parsers、Renderers、Authentication、Permissions 等组件，以满足特定的业务需求。
遵循 RESTful 原则： DRF 的设计哲学鼓励开发者遵循 RESTful 架构风格，这有助于构建出结构清晰、易于理解和维护的 API。

总而言之，如果你正在使用 Django 并且需要构建 API，DRF 几乎是标准选择。它将你从大量重复的基础工作中解放出来，让你能更专注于业务逻辑的实现。

DRF 的核心概念解析

要快速理解 DRF，掌握其几个核心概念至关重要。它们是 DRF 魔法的基石：

1. Serializers (序列化器)

核心作用： 数据转换 和 数据验证。

数据转换： 将复杂的数据类型（如 Django 模型实例、QuerySet）转换为易于传输和使用的格式（如 JSON、XML 等）。例如，将数据库中的一个用户对象转换为一个 JSON 字典，包含用户名、邮箱等字段。
数据验证： 在接收客户端发送的数据时，对数据进行结构和内容的校验，确保数据格式正确、类型匹配、满足业务规则等。例如，校验用户注册时提供的邮箱格式是否正确，密码长度是否满足要求。

类比： Serializer 就像一个数据翻译器和质检员。它把 Python 对象“翻译”成 API 消费者能理解的格式，同时在接收外部数据时进行“质检”，确保数据的有效性。

主要类型：

Serializer: 最基础的序列化器类，需要手动定义字段。
ModelSerializer: 这是最常用的类型。它可以自动根据 Django 模型生成相应的字段和基础验证规则，大大简化了序列化器的定义。你只需指定 model 和 fields (或 exclude) 属性即可。

示例 (概念性):

“`python

serializers.py

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
class Meta:
model = Product
fields = [‘id’, ‘name’, ‘price’, ‘stock’, ‘created_at’]
# 或者 fields = ‘all‘
# 或者 exclude = [‘updated_at’]

使用示例 (在视图中):

序列化一个对象:

product = Product.objects.get(id=1)

serializer = ProductSerializer(product)

print(serializer.data) # 输出字典，将被渲染为 JSON

序列化一个 QuerySet (多个对象):

products = Product.objects.all()

serializer = ProductSerializer(products, many=True) # many=True 表示处理多个对象

print(serializer.data) # 输出列表，将被渲染为 JSON 数组

反序列化和验证:

data = {‘name’: ‘New Product’, ‘price’: 100.0, ‘stock’: 50} # 从请求中获取的数据

serializer = ProductSerializer(data=data)

serializer.is_valid(raise_exception=True) # 进行验证，失败会抛出异常

product = serializer.save() # 验证通过后，保存到数据库

“`

Serializers 是 DRF 数据处理的核心，理解它如何工作（序列化和反序列化，特别是验证）是掌握 DRF 的关键一步。

2. Views (视图) & ViewSets (视图集)

核心作用： 处理 HTTP 请求，调用序列化器进行数据处理，返回 HTTP 响应。

Views (APIView): DRF 提供了 rest_framework.views.APIView 作为基础视图类。它继承自 Django 的 View，但提供了更丰富的功能，如请求解析、响应渲染、认证、权限、限流等。你可以在其子类中定义 get(), post(), put(), delete() 等方法来处理不同的 HTTP 请求。这类似于 Django 的类视图，但专门针对 API。
Generic APIView & Mixins: GenericAPIView 继承自 APIView，并增加了一些处理常见列表和详情操作的属性 (如 queryset, serializer_class, lookup_field) 和方法。DRF 提供了一系列 Mixins (如 ListModelMixin, RetrieveModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin)，可以将这些 Mixins 与 GenericAPIView 组合使用，快速构建出具有特定功能的视图。例如，ListAPIView 就是 GenericAPIView 和 ListModelMixin 的组合。
ViewSets: ViewSet 是比 APIView 更高层次的抽象。它将一组相关的视图逻辑（如 CRUD 操作）封装到一个类中，而不是像传统视图那样为每个操作（列表、详情）定义一个单独的类。ViewSet 的方法通常不是 get() post() 等 HTTP 方法名，而是 list(), retrieve(), create(), update(), partial_update(), destroy() 等动作 (actions)。ViewSet 本身不提供 URL 路由，它需要配合 Routers 使用。

类比： Views/ViewSets 就像 API 的控制器或处理者。它们接收外部来的请求，根据请求的类型和内容，调用相应的逻辑（包括序列化器），并准备好返回给客户端的数据。ViewSet 就像是一个“多功能控制器”，能处理多种相关的请求。

示例 (概念性):

“`python

views.py

from rest_framework import generics, viewsets
from .models import Product
from .serializers import ProductSerializer
from rest_framework.permissions import IsAuthenticatedOrReadOnly # 引入权限类

使用 Generic Views (例如 ListAPIView 和 RetrieveAPIView)

class ProductListAPIView(generics.ListCreateAPIView): # 继承 ListModelMixin 和 CreateModelMixin

queryset = Product.objects.all()

serializer_class = ProductSerializer

permission_classes = [IsAuthenticatedOrReadOnly] # 需要认证才能创建，否则只读

class ProductDetailAPIView(generics.RetrieveUpdateDestroyAPIView): # 继承 Retrieve, Update, Destroy Mixins

queryset = Product.objects.all()

serializer_class = ProductSerializer

permission_classes = [IsAuthenticatedOrReadOnly]

使用 ViewSets (通常更推荐用于 CRUD 操作)

class ProductViewSet(viewsets.ModelViewSet): # ModelViewSet 继承了所有的 CRUD Mixins 和 GenericAPIView
queryset = Product.objects.all()
serializer_class = ProductSerializer
permission_classes = [IsAuthenticatedOrReadOnly]
# ModelViewSet 会自动提供 list, retrieve, create, update, partial_update, destroy 等方法
“`

理解 Generic Views 和 ViewSets 的区别与适用场景非常重要。通用视图适用于更细粒度的控制或简单的单功能端点，而 ViewSets 结合 Routers 则非常适合处理模型资源的整套 CRUD 操作，代码更简洁。

3. Routers (路由)

核心作用： 自动生成 URL 模式，通常用于 ViewSets。

当使用 ViewSets 时，由于一个 ViewSet 类包含了多个动作 (actions)，手动为每个动作编写 URL 模式会很繁琐。DRF 的 Routers (如 DefaultRouter, SimpleRouter) 可以检查 ViewSet 定义的动作，并自动生成对应的 URL 模式。

类比： Router 就像一个智能的“路牌生成器”。你告诉它有哪些“多功能控制器”（ViewSets），它就能自动为你设置好通往这些控制器中不同“功能区”（actions）的路牌（URLs）。

示例 (概念性):

“`python

urls.py

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import ProductViewSet

创建一个 Router 实例

router = DefaultRouter()

注册你的 ViewSet。第一个参数是 URL 前缀，第二个是 ViewSet 类

router.register(r’products’, ProductViewSet)

urlpatterns = [
# 将 Router 生成的 URL 模式包含进来
path(”, include(router.urls)),
# 你也可以添加其他的 URL 模式
# path(‘some-other-api/’, SomeOtherAPIView.as_view(), name=’some_other_api’),
]

此时，访问 /products/ 会对应 ProductViewSet.list()

访问 /products/1/ 会对应 ProductViewSet.retrieve(pk=1)

对 /products/ 发送 POST 请求会对应 ProductViewSet.create()

对 /products/1/ 发送 PUT/PATCH 请求会对应 ProductViewSet.update()/partial_update()

对 /products/1/ 发送 DELETE 请求会对应 ProductViewSet.destroy()

“`

Routers 极大地简化了 ViewSet 的 URL 配置，是使用 ViewSet 的标配。

4. Requests (请求) & Responses (响应)

核心作用： 增强 Django 的 HttpRequest 和 HttpResponse，提供更适合 API 处理的功能。

Request (rest_framework.request.Request): DRF 的 Request 对象封装了 Django 的 HttpRequest，并提供了更方便访问请求数据和进行内容协商的方法。例如，request.data 可以统一访问 POST、PUT、PATCH 请求体中的数据，无论其格式是 JSON、表单数据还是文件。request.query_params 用于访问 URL 查询参数。
Response (rest_framework.response.Response): DRF 的 Response 对象继承自 Django 的 HttpResponse，并提供了内容协商功能。你可以直接将 Python 数据结构 (如字典、列表) 传递给 Response，DRF 会根据客户端请求的 Accept 头部和视图配置的 renderer_classes 自动选择最合适的渲染器（默认是 JSONRenderer 和 BrowsableAPIRenderer）将数据转换为相应的格式返回。

示例 (概念性):

“`python

在 APIView 或 ViewSet 中:

from rest_framework.response import Response
from rest_framework.views import APIView

class ExampleAPIView(APIView):
def post(self, request):
# 使用 request.data 访问请求体数据
data_received = request.data

    # 进行处理...

    # 构建 Response 对象，直接传递 Python 数据
    data_to_return = {'message': 'Data received', 'your_data': data_received}
    # DRF 会自动将 data_to_return 渲染成 JSON 或其他格式
    return Response(data_to_return, status=201) # 可以设置 HTTP 状态码

“`

使用 DRF 的 Request 和 Response 对象是构建 API 的标准方式，它们提供了比 Django 原生对象更强大的功能和便利性。

5. Authentication (认证) & Permissions (权限)

核心作用： 识别谁在访问 和 决定是否有权访问。

Authentication (认证): 解决“你是谁？”的问题。DRF 提供了多种认证类，如 TokenAuthentication (基于 Token 的认证，常用于移动应用或前后端分离项目)、SessionAuthentication (基于 Session 的认证，常用于与 Django 自带模板系统结合的前后端不分离项目)、BasicAuthentication 等。你可以在视图或全局设置中配置使用的认证类。
Permissions (权限): 解决“你被允许做什么？”的问题。在用户身份被认证后，权限类用于判断该用户是否有权执行当前请求的操作（如读取数据、创建对象、修改对象）。DRF 提供了丰富的权限类，如 AllowAny (允许任何人访问)、IsAuthenticated (只允许认证用户访问)、IsAdminUser (只允许管理员访问)、IsAuthenticatedOrReadOnly (认证用户可写，未认证用户只读)、DjangoModelPermissions 等。你也可以自定义权限类。

示例 (概念性):

“`python

在 views.py 中

from rest_framework import generics
from rest_framework.permissions import IsAuthenticated, IsAdminUser
from rest_framework.authentication import TokenAuthentication # 假设使用 Token 认证

class SecuredAPIView(generics.ListAPIView):
authentication_classes = [TokenAuthentication] # 指定认证方式
permission_classes = [IsAuthenticated] # 指定权限要求 (必须是认证用户)
# … 其他属性如 queryset, serializer_class

class AdminOnlyAPIView(generics.CreateAPIView):
authentication_classes = [TokenAuthentication]
permission_classes = [IsAdminUser] # 指定权限要求 (必须是管理员)
# … 其他属性
“`

认证和权限是构建安全 API 的关键部分，DRF 提供了一个强大且灵活的系统来处理它们。

6. Pagination (分页)

核心作用： 控制大型数据集的返回，避免一次性加载过多数据导致性能问题。

当返回列表数据时，如果数据集非常大，一次性全部返回会导致响应缓慢、占用大量内存和带宽。分页机制允许你只返回部分数据（一页），并通过链接提供下一页、上一页等信息。

DRF 提供了多种分页类，如 PageNumberPagination (基于页码)、LimitOffsetPagination (基于偏移量和数量)。你可以在视图或全局设置中配置分页策略。

示例 (概念性):

“`python

settings.py (全局配置)

REST_FRAMEWORK = {
‘DEFAULT_PAGINATION_CLASS’: ‘rest_framework.pagination.PageNumberPagination’,
‘PAGE_SIZE’: 10 # 每页10条数据
}

views.py (视图中覆盖或使用其他分页类)

from rest_framework import generics
from rest_framework.pagination import LimitOffsetPagination

class MyListView(generics.ListAPIView):
queryset = …
serializer_class = …
pagination_class = LimitOffsetPagination # 在这个视图中使用 LimitOffsetPagination
“`

7. Parsers (解析器) & Renderers (渲染器)

核心作用： 处理请求体格式 和 处理响应体格式。

Parsers: DRF 使用 Parsers 来解析客户端发送的请求体。默认支持 JSONParser (解析 JSON 数据)、FormParser (解析表单数据，application/x-www-form-urlencoded)、MultiPartParser (解析多部分表单数据，multipart/form-data，用于文件上传)。你可以根据需要添加自定义 Parsers。
Renderers: DRF 使用 Renderers 将 Python 数据结构渲染成发送给客户端的响应体。默认支持 JSONRenderer (渲染为 JSON) 和 BrowsableAPIRenderer (渲染为可浏览的 HTML 界面)。你也可以添加自定义 Renderers，如 XMLRenderer, YAMLRenderer 等。

这些组件通常在后台静默工作，但理解它们的存在有助于理解 DRF 如何处理不同的数据格式。你可以在视图中通过设置 parser_classes 和 renderer_classes 属性来覆盖默认配置。

8. Throttling (限流)

核心作用： 限制客户端的请求频率，保护 API 不被滥用或恶意访问。

DRF 提供了 Throttle 类来限制用户或 IP 在一定时间内的请求次数。常见的限流策略有 AnonRateThrottle (限制未认证用户的 IP 请求频率) 和 UserRateThrottle (限制认证用户的请求频率)。

示例 (概念性):

“`python

settings.py (全局配置)

REST_FRAMEWORK = {
‘DEFAULT_THROTTLE_CLASSES’: [
‘rest_framework.throttling.AnonRateThrottle’,
‘rest_framework.throttling.UserRateThrottle’
],
‘DEFAULT_THROTTLE_RATES’: {
‘anon’: ‘100/hour’, # 未认证用户每小时最多100次请求
‘user’: ‘1000/day’ # 认证用户每天最多1000次请求
}
}

或在视图中配置

class MyAPIView(APIView):
throttle_classes = [AnonRateThrottle]
# …
“`

快速上手 DRF (简化流程)

了解了核心概念后，如何快速开始使用 DRF 呢？以下是一个简化的步骤概览：

安装 DRF：
bash pip install djangorestframework
添加到 INSTALLED_APPS： 在你的 Django 项目的 settings.py 文件中，将 'rest_framework' 添加到 INSTALLED_APPS 列表中。
python INSTALLED_APPS = [ # ... 其他 apps 'rest_framework', ]
创建模型 (如果还没有)： 定义你需要在 API 中暴露的数据模型。
“`python
# models.py
from django.db import models

class Item(models.Model):
name = models.CharField(max_length=100)
value = models.IntegerField(default=0)
created_at = models.DateTimeField(auto_now_add=True)
```
def __str__(self):
    return self.name
```
运行迁移命令：`python manage.py makemigrations` 和 `python manage.py migrate`。 4. **创建 Serializer：** 为你的模型创建一个 ModelSerializer。python

serializers.py

from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
class Meta:
model = Item
fields = ‘all‘ # 或指定具体字段列表
5. **创建 ViewSet (或 Views)：** 创建一个 ViewSet 来处理模型的 CRUD 操作。python

views.py

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

from rest_framework.permissions import IsAuthenticatedOrReadOnly # 可选：添加权限

class ItemViewSet(viewsets.ModelViewSet):
queryset = Item.objects.all()
serializer_class = ItemSerializer
# permission_classes = [IsAuthenticatedOrReadOnly] # 可选：设置权限
6. **配置 URL 路由：** 在你的应用的 `urls.py` 或项目的 `urls.py` 中使用 Router 配置 ViewSet 的 URL。python

urls.py (在你想要定义 API 路由的地方)

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

router = DefaultRouter()
router.register(r’items’, ItemViewSet) # URL 前缀是 ‘items’

urlpatterns = [
path(‘api/’, include(router.urls)), # 将 ViewSet 的路由包含在 /api/ 下
# … 其他 urls
]
`` 7. **运行服务器并测试：** 启动你的 Django 开发服务器 (python manage.py runserver`)。

现在，你可以通过浏览器访问 /api/items/。如果开启了 Browsable API，你会看到一个漂亮的界面，展示了物品列表，并且可以通过界面进行创建物品的操作。访问 /api/items/1/ 可以查看、更新或删除 ID 为 1 的物品。

这个流程展示了使用 DRF 快速构建模型基础 API 的强大之处。对于更复杂的逻辑和非模型相关的 API，你可以使用 APIView 或结合 GenericAPIView 和 Mixins 来构建视图。

DRF 的高级特性概览

除了上述核心概念和快速上手流程，DRF 还提供了许多高级特性和扩展点，用于构建更复杂和强大的 API：

自定义 Serializers 和 Fields： 当 ModelSerializer 不够用时，你可以创建自定义 Serializer 类，甚至定义自定义字段类型，以精确控制数据的序列化和验证逻辑。
过滤 (Filtering) 和排序 (Ordering)： DRF 提供了与 django-filter 集成来轻松实现基于查询参数的数据过滤，以及基于查询参数的数据排序。
版本控制 (Versioning)： 支持多种 API 版本控制策略 (URL 版本、Header 版本、Query Parameter 版本等)，方便 API 的迭代和升级。
文档生成： 可以与第三方库 (如 drf-yasg, coreapi, openapi) 集成，自动生成符合 OpenAPI (Swagger) 规范的 API 文档。
测试工具： 提供了方便的 APITestCase 和 APIClient 类，用于编写 API 的自动化测试。
内容协商： 灵活处理客户端请求的 Accept 头部和服务器响应的 Content-Type 头部，支持多种数据格式的交互。
异常处理： 提供统一的异常处理机制，可以将框架或业务异常格式化为标准化的 API 错误响应。

这些高级特性让 DRF 不仅适用于简单的 CRUD API，也能够满足企业级复杂 API 的构建需求。

DRF 的学习曲线和注意事项

尽管 DRF 极大地提高了开发效率，但对于新手来说，也存在一定的学习曲线。主要挑战在于：

概念众多： Serializer、View、ViewSet、Router、Authentication、Permission 等概念初识时可能感觉有点多，需要时间理解它们各自的作用和相互之间的协作关系。
抽象层次高： ModelSerializer、GenericAPIView、ModelViewSet 等高级抽象虽然方便，但也意味着它们背后隐藏了很多细节。理解这些细节（例如 ModelSerializer 自动做了哪些验证，ModelViewSet 如何映射到 HTTP 方法）有助于解决问题和进行定制。
灵活性带来的选择： 有时一个功能有多种实现方式（例如，使用 APIView 手动处理序列化和验证，或者使用 GenericAPIView 结合 Mixins，或者使用 ViewSet）。选择最适合当前场景的方式需要经验。

建议的学习路径：

扎实掌握 Django 基础 (模型、视图、URL、ORM)。
阅读 DRF 官方文档的“快速入门” (Quickstart) 部分，动手实践。
深入学习 Serializers 的使用，特别是 ModelSerializer 和数据验证。
理解 Views (APIView, GenericAPIView, Mixins) 和 ViewSets 的区别与联系。
学习如何使用 Routers 配置 ViewSets 的 URL。
掌握认证和权限的基本用法。
逐步探索分页、过滤、版本控制等高级特性。

通过大量的练习和参考官方文档，你会逐渐熟悉并精通 DRF。

总结

Django REST Framework (DRF) 是 Django 生态系统中构建 Web API 的事实标准。它通过提供一套强大、灵活且高度可定制的工具集，解决了使用 Django 原生功能构建 API 时面临的诸多挑战。

DRF 的核心在于其对序列化、视图、认证、权限等 API 核心环节的抽象和优化。Serializers 负责数据转换和验证，Views/ViewSets 处理请求和业务逻辑，Routers 简化 URL 配置，Requests/Responses 增强数据交互，Authentication/Permissions 保障 API 安全。

选择 DRF 意味着你可以：

以惊人的速度构建功能完备的 API。
编写更少、更清晰、更易维护的代码。
利用内置的安全机制保护你的 API。
为开发者提供友好的 Browsable API 界面。
受益于活跃的社区和优秀的文档。

虽然初学时可能需要投入一些精力理解其核心概念，但一旦掌握，DRF 将成为你构建现代 Web 应用后端服务的强大臂助。如果你是 Django 开发者并且需要构建 API，那么深入学习和使用 Django REST Framework 绝对是一个明智的选择。它将显著提升你的开发效率和 API 的专业水平。

希望这篇文章能帮助你快速、全面地了解 Django REST Framework 是什么以及它为何如此重要和流行！现在，是时候深入官方文档，开始你的 DRF 实践之旅了！

揭开 RESTful API 开发利器：深入了解 Django REST Framework (DRF)

什么是 Django REST Framework (DRF)?

为什么选择 Django REST Framework (DRF)?

DRF 的核心概念解析

1. Serializers (序列化器)

serializers.py

使用示例 (在视图中):

序列化一个对象:

product = Product.objects.get(id=1)

serializer = ProductSerializer(product)

print(serializer.data) # 输出字典，将被渲染为 JSON

序列化一个 QuerySet (多个对象):

products = Product.objects.all()

serializer = ProductSerializer(products, many=True) # many=True 表示处理多个对象

print(serializer.data) # 输出列表，将被渲染为 JSON 数组

反序列化和验证:

data = {‘name’: ‘New Product’, ‘price’: 100.0, ‘stock’: 50} # 从请求中获取的数据

serializer = ProductSerializer(data=data)

serializer.is_valid(raise_exception=True) # 进行验证，失败会抛出异常

product = serializer.save() # 验证通过后，保存到数据库

2. Views (视图) & ViewSets (视图集)

views.py

使用 Generic Views (例如 ListAPIView 和 RetrieveAPIView)

class ProductListAPIView(generics.ListCreateAPIView): # 继承 ListModelMixin 和 CreateModelMixin

queryset = Product.objects.all()

serializer_class = ProductSerializer

permission_classes = [IsAuthenticatedOrReadOnly] # 需要认证才能创建，否则只读

class ProductDetailAPIView(generics.RetrieveUpdateDestroyAPIView): # 继承 Retrieve, Update, Destroy Mixins

queryset = Product.objects.all()

serializer_class = ProductSerializer

permission_classes = [IsAuthenticatedOrReadOnly]

使用 ViewSets (通常更推荐用于 CRUD 操作)

3. Routers (路由)

urls.py

创建一个 Router 实例

注册你的 ViewSet。第一个参数是 URL 前缀，第二个是 ViewSet 类

此时，访问 /products/ 会对应 ProductViewSet.list()

访问 /products/1/ 会对应 ProductViewSet.retrieve(pk=1)

对 /products/ 发送 POST 请求会对应 ProductViewSet.create()

对 /products/1/ 发送 PUT/PATCH 请求会对应 ProductViewSet.update()/partial_update()

对 /products/1/ 发送 DELETE 请求会对应 ProductViewSet.destroy()

4. Requests (请求) & Responses (响应)

在 APIView 或 ViewSet 中:

5. Authentication (认证) & Permissions (权限)

在 views.py 中

6. Pagination (分页)

settings.py (全局配置)

views.py (视图中覆盖或使用其他分页类)

7. Parsers (解析器) & Renderers (渲染器)

8. Throttling (限流)

settings.py (全局配置)

或在视图中配置

快速上手 DRF (简化流程)

serializers.py

views.py

from rest_framework.permissions import IsAuthenticatedOrReadOnly # 可选：添加权限

urls.py (在你想要定义 API 路由的地方)

DRF 的高级特性概览

DRF 的学习曲线和注意事项

总结

发表评论 取消回复

发表评论取消回复