Django REST Framework 介绍 – wiki词典

作者： /

Django REST Framework (DRF) 介绍

Django REST Framework (DRF) 是一个强大而灵活的工具包，用于构建 Web API。它建立在 Django 框架之上，极大地简化了 RESTful API 的开发过程。DRF 提供了构建可扩展、易于维护的 Web API 所需的各种功能和组件。

为什么选择 Django REST Framework？

在现代 Web 开发中，API 扮演着至关重要的角色。它们允许不同的应用程序（例如前端界面、移动应用、第三方服务）之间进行数据交互。Django 作为一个全能的 Web 框架，本身可以处理 HTTP 请求和响应，但构建 RESTful API 有其特定的挑战，例如：

  • 序列化与反序列化： 如何将复杂的 Django 模型实例转换为 JSON/XML 等格式，以及如何将传入的 JSON/XML 数据转换为模型实例并进行验证。
  • 视图逻辑： 如何高效地处理各种 HTTP 方法（GET, POST, PUT, DELETE）并与数据库交互。
  • 认证与权限： 如何保护 API 端点，确保只有授权用户才能访问。
  • 路由： 如何优雅地将 URL 映射到 API 视图。
  • 分页、过滤与搜索： 如何处理大量数据的查询和展示。
  • 文档： 如何为 API 生成交互式文档。

DRF 旨在解决这些挑战，提供了一套全面的解决方案，让开发者能够专注于业务逻辑而不是底层实现。

DRF 的核心组件

DRF 提供了一系列抽象和组件，使得 API 开发变得高效：

  1. Serializers (序列化器)

    • 序列化器是 DRF 的核心概念之一。它们负责将 Django 模型实例（或其他 Python 对象）转换为可轻松传输的数据格式（如 JSON、XML），同时也能将传入的数据反序列化回 Python 对象，并进行数据验证。
    • DRF 提供了 Serializer 类，以及更便捷的 ModelSerializer。ModelSerializer 可以自动从 Django 模型生成字段，并提供 create() 和 update() 方法的默认实现。

    • 示例：
      “`python
      from rest_framework import serializers
      from .models import MyModel

      class MyModelSerializer(serializers.ModelSerializer):
      class Meta:
      model = MyModel
      fields = ‘all‘ # 或指定需要序列化的字段
      “`

  2. Views (视图)

    • DRF 扩展了 Django 的 View 概念，提供了更适合 API 开发的视图类型。
    • APIView: 最基础的 API 视图类，类似于 Django 的 View，但增加了对 DRF 的请求和响应对象、认证、权限、限流等功能的支持。你需要手动处理 HTTP 方法。
    • GenericAPIView: 在 APIView 的基础上，增加了与序列化器和 queryset 交互的常用方法和属性，如 get_queryset(), get_serializer_class()。它没有提供具体的 HTTP 方法实现。
    • Mixin Classes (混合类): DRF 提供了一系列混合类，如 ListModelMixin, RetrieveModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin。它们包含了常见 CRUD 操作的逻辑。你可以将它们与 GenericAPIView 结合使用来快速构建视图。
    • ViewSets (视图集): ViewSet 将相关联的逻辑操作（如 list, retrieve, create, update, destroy）组合在一个类中。这使得代码更加 DRY（Don’t Repeat Yourself），并与 DRF 的路由器（Routers）配合使用，可以自动生成 URL 配置。

    • 示例：
      “`python
      from rest_framework import viewsets
      from .models import MyModel
      from .serializers import MyModelSerializer

      class MyModelViewSet(viewsets.ModelViewSet):
      queryset = MyModel.objects.all()
      serializer_class = MyModelSerializer
      “`

  3. Requests & Responses (请求与响应)

    • DRF 提供了增强的 Request 对象，它扩展了 Django 的 HttpRequest，提供了更灵活的请求解析（支持 JSON、XML 等内容类型）。
    • Response 对象允许你将数据渲染成多种内容类型（默认是 JSON），并自动设置正确的 HTTP 状态码和头信息。

  4. Authentication & Permissions (认证与权限)

    • 认证 (Authentication): 用于验证请求的发送者是谁。DRF 提供了多种认证方式，如 TokenAuthentication, SessionAuthentication, BasicAuthentication。
    • 权限 (Permissions): 用于确定经过认证的用户是否有权执行某个操作。DRF 提供了 IsAuthenticated, IsAdminUser, AllowAny 等通用权限类，你也可以自定义权限逻辑。

    • 示例：
      “`python
      from rest_framework.permissions import IsAuthenticated
      from rest_framework.authentication import TokenAuthentication

      class MyProtectedViewSet(viewsets.ModelViewSet):
      authentication_classes = [TokenAuthentication]
      permission_classes = [IsAuthenticated]
      # …
      “`

  5. Routers (路由器)

    • Router 简化了 URL 配置。它根据 ViewSet 自动生成常见的 URL 模式（如 /items/, /items/{id}/）。
    • DRF 提供了 SimpleRouter 和 DefaultRouter。DefaultRouter 还会自动生成 API 的根视图和可选的格式后缀。

    • 示例：
      “`python
      from rest_framework.routers import DefaultRouter
      from .views import MyModelViewSet

      router = DefaultRouter()
      router.register(r’mymodels’, MyModelViewSet)

      urlpatterns = [
      # … 其他 URL 模式
      ] + router.urls
      “`

  6. Parsers & Renderers (解析器与渲染器)

    • 解析器 (Parsers): 用于解析传入请求的请求体。DRF 默认支持 JSONParser, FormParser, MultiPartParser。
    • 渲染器 (Renderers): 用于将响应数据渲染成特定的媒体类型。DRF 默认支持 JSONRenderer, BrowsableAPIRenderer (用于提供可浏览的 API 界面)。

  7. Pagination, Filtering & Search (分页、过滤与搜索)

    • DRF 提供了多种内置的分页类 (PageNumberPagination, LimitOffsetPagination, CursorPagination)，以及强大的过滤和搜索后端。

    • 示例：
      “`python
      from rest_framework import filters
      from rest_framework.pagination import PageNumberPagination

      class CustomPagination(PageNumberPagination):
      page_size = 10
      page_size_query_param = ‘page_size’
      max_page_size = 100

      class MyFilterableViewSet(viewsets.ModelViewSet):
      queryset = MyModel.objects.all()
      serializer_class = MyModelSerializer
      pagination_class = CustomPagination
      filter_backends = [filters.SearchFilter, filters.OrderingFilter]
      search_fields = [‘name’, ‘description’] # 允许通过 name 和 description 字段搜索
      ordering_fields = [‘created_at’, ‘name’] # 允许通过 created_at 和 name 字段排序
      “`

优点

  • 开发速度快： 通过 ModelSerializer、ViewSet 和 Router，可以迅速构建出功能完备的 CRUD API。
  • 可浏览的 API： BrowsableAPIRenderer 提供了一个用户友好的 Web 界面，可以直接在浏览器中测试和查看 API，极大地提升了开发体验。
  • 强大的功能： 内置了认证、权限、限流、分页、过滤、搜索等高级功能。
  • 高度可定制： 几乎所有组件都可以轻松扩展或替换，以满足特定的业务需求。
  • 文档生成： 易于集成 Swagger/OpenAPI 等工具，自动生成 API 文档。
  • 社区活跃： 拥有庞大而活跃的社区，提供丰富的文档和支持。

总结

Django REST Framework 是构建 RESTful API 的首选框架之一，特别是对于那些已经熟悉 Django 生态系统的开发者。它提供了一套高效、强大且高度可定制的工具，能够帮助开发者快速、优雅地构建高质量的 Web API，从而加速应用程序的开发和迭代。无论你是构建简单的后端服务还是复杂的微服务架构，DRF 都能提供坚实的基础。

滚动至顶部