基于 Django REST framework 实现 RESTful API 的一些技巧-JavaScript中文网-JavaScript教程资源分享门户

RESTful API 是现代 Web 开发中不可或缺的一部分，它将 Web 应用程序的数据和功能以统一的、可缓存的、可扩展的、可组合的方式暴露出去，使得不同的客户端（如 Web 浏览器、移动设备、桌面应用程序等）可以通过 HTTP 协议访问和操作这些资源。在 Django 框架中，Django REST framework（简称 DRF）是一个强大且灵活的工具集，可以帮助开发人员快速构建 RESTful API，本文将介绍一些基于 DRF 实现 RESTful API 的技巧。

1. 使用 Serializer 进行数据序列化和反序列化

在 RESTful API 中，数据通常以 JSON 或 XML 格式传输，因此需要将 Django 模型对象转换为序列化后的数据，或者将客户端提交的数据反序列化为 Django 模型对象。DRF 提供了 Serializer 类来完成这些转换工作。

例如，假设有一个名为 Book 的 Django 模型，包含 title、author 和 pub_date 三个字段，可以定义一个 BookSerializer 类来完成数据序列化和反序列化：

from rest_framework import serializers
from .models import Book

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

在视图函数中，可以使用该 Serializer 类将 Django 模型对象序列化为 JSON 或 XML 格式的数据：

from rest_framework.decorators import api_view
from rest_framework.response import Response

@api_view(['GET'])
def book_list(request):
    books = Book.objects.all()
    serializer = BookSerializer(books, many=True)
    return Response(serializer.data)

在客户端提交数据时，可以使用该 Serializer 类将 JSON 或 XML 格式的数据反序列化为 Django 模型对象：

@api_view(['POST'])
def book_create(request):
    serializer = BookSerializer(data=request.data)
    if serializer.is_valid():
        serializer.save()
        return Response(serializer.data, status=201)
    return Response(serializer.errors, status=400)

2. 使用 ViewSet 和 Router 简化视图函数的编写

在 Django 中，视图函数是处理 HTTP 请求的核心部分，但是随着 RESTful API 的增多，视图函数的数量也会不断增加，导致代码冗长和可读性降低。DRF 提供了 ViewSet 和 Router 类来简化视图函数的编写和 URL 映射的配置。

ViewSet 是一个包含多个视图函数的类，可以根据 HTTP 方法（如 GET、POST、PUT、DELETE 等）自动调用不同的视图函数。例如，假设有一个名为 BookViewSet 的类，包含 list、create、retrieve、update 和 destroy 五个视图函数，可以定义如下：

from rest_framework import viewsets
from .serializers import BookSerializer
from .models import Book

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

在 Router 中注册该 ViewSet 类，可以自动生成 URL 映射：

// www.javascriptcn.com code example
from django.urls import path, include
from rest_framework import routers
from .views import BookViewSet

router = routers.DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

以上代码将自动生成如下 URL 映射：

GET /books/ => book_list
POST /books/ => book_create
GET /books/{id}/ => book_retrieve
PUT /books/{id}/ => book_update
DELETE /books/{id}/ => book_destroy

3. 使用 Authentication 和 Permission 控制 API 访问权限

在 RESTful API 中，安全性是一个重要的问题，需要对 API 的访问进行授权和认证。DRF 提供了 Authentication 和 Permission 类来控制 API 的访问权限。

Authentication 类用于认证用户身份，常见的认证方式包括 BasicAuthentication、TokenAuthentication、SessionAuthentication 等。例如，可以使用 TokenAuthentication 类来实现基于 Token 的认证：

from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = [TokenAuthentication]
    permission_classes = [IsAuthenticated]

以上代码表示只有经过 Token 认证的用户才能访问该 API。

Permission 类用于控制用户的访问权限，常见的权限控制方式包括 IsAuthenticated、IsAdminUser、AllowAny 等。例如，可以使用 IsAdminUser 类来实现管理员权限控制：

from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAdminUser

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = [TokenAuthentication]
    permission_classes = [IsAdminUser]

以上代码表示只有管理员用户才能访问该 API。

4. 使用 Filter 和 Pagination 进行数据过滤和分页

在 RESTful API 中，数据通常需要进行过滤和分页，以提高查询效率和用户体验。DRF 提供了 Filter 和 Pagination 类来实现数据过滤和分页。

Filter 类用于实现数据过滤，常见的过滤方式包括精确匹配、模糊匹配、范围匹配等。例如，可以使用 SearchFilter 类来实现基于关键字搜索的过滤：

from rest_framework.filters import SearchFilter

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_backends = [SearchFilter]
    search_fields = ['title', 'author']

以上代码表示可以通过 /books/?search=keyword 的方式进行关键字搜索。

Pagination 类用于实现数据分页，常见的分页方式包括基于页码的分页、基于偏移量的分页、基于游标的分页等。例如，可以使用 PageNumberPagination 类来实现基于页码的分页：

from rest_framework.pagination import PageNumberPagination

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = PageNumberPagination
    page_size = 10

以上代码表示每页显示 10 条数据。

结语

本文介绍了基于 DRF 实现 RESTful API 的一些技巧，包括使用 Serializer 进行数据序列化和反序列化、使用 ViewSet 和 Router 简化视图函数的编写、使用 Authentication 和 Permission 控制 API 访问权限、使用 Filter 和 Pagination 进行数据过滤和分页等。这些技巧可以帮助开发人员快速构建高效、安全、可扩展的 RESTful API，提高 Web 应用程序的质量和用户体验。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67d8ff41a941bf71340683de

基于 Django REST framework 实现 RESTful API 的一些技巧

1. 使用 Serializer 进行数据序列化和反序列化

2. 使用 ViewSet 和 Router 简化视图函数的编写

3. 使用 Authentication 和 Permission 控制 API 访问权限

4. 使用 Filter 和 Pagination 进行数据过滤和分页

结语

接着读