DRF-Spectacular中实现带分页的响应数据封装方案

概述

在使用DRF-Spectacular生成API文档时，开发者经常需要将响应数据封装在统一的格式中，同时保持分页功能。本文将详细介绍如何在DRF-Spectacular中实现这种需求。

问题背景

在REST API开发中，常见的需求是将响应数据封装在统一的结构中，通常包含状态、消息、状态码和实际数据。同时，对于列表数据，我们还需要保留分页信息。然而，当使用DRF-Spectacular的自动Schema生成时，直接将分页数据嵌套在封装结构中会遇到挑战。

解决方案

基础封装方案

最初，开发者可能会尝试使用简单的封装器(Envelope)来包裹响应数据：

def enveloper(serializer_class, many):
    @extend_schema_serializer(many=False)
    class EnvelopeSerializer(serializers.Serializer):
        status = serializers.BooleanField(initial=True)
        detail = serializers.CharField(default="Success")
        code = serializers.IntegerField(default=HTTP_200_OK)
        data = serializer_class(many=True)
    
    return EnvelopeSerializer

这种方法虽然能实现基本的数据封装，但会导致分页信息丢失，因为DRF的分页机制默认只作用于最外层响应。

进阶解决方案

为了同时保留封装结构和分页功能，我们需要结合DRF-Spectacular的扩展机制。以下是完整的实现方案：

from drf_spectacular.openapi import AutoSchema
from drf_spectacular.plumbing import get_class
from drf_spectacular.utils import extend_schema_field, extend_schema_serializer
from rest_framework import serializers
from rest_framework.fields import CharField, IntegerField, SerializerMethodField
from rest_framework.settings import api_settings
from rest_framework.status import HTTP_200_OK

class PaginationWrapper(serializers.BaseSerializer):
    def __init__(self, serializer_class, pagination_class, **kwargs):
        self.serializer_class = serializer_class
        self.pagination_class = pagination_class
        super().__init__(**kwargs)

def paginated_enveloper(serializer_class, many=True, pagination_class=None):
    component_name = "FormatedPaginated{}".format(
        serializer_class.__name__.replace("Serializer", ""),
        "" if many else "",
    )
    if not pagination_class:
        pagination_class = api_settings.DEFAULT_PAGINATION_CLASS

    @extend_schema_serializer(many=False, component_name=component_name)
    class EnvelopePaginatedSerializer(serializers.Serializer):
        status = serializers.BooleanField(initial=True)
        detail = serializers.CharField(default="Success")
        code = serializers.IntegerField(default=HTTP_200_OK)
        data = serializers.SerializerMethodField()

        @extend_schema_field(
            PaginationWrapper(
                serializer_class=serializer_class, 
                pagination_class=pagination_class
            )
        )
        def get_data(self, obj):
            pass

    return EnvelopePaginatedSerializer

实现原理

1. PaginationWrapper类：这是一个特殊的序列化器类，用于标记需要分页的数据结构。它本身不实现任何序列化逻辑，只是作为DRF-Spectacular扩展的触发器。

2. paginated_enveloper函数：创建了一个包含状态信息和数据字段的封装序列化器。数据字段使用SerializerMethodField，并通过@extend_schema_field装饰器指定其结构。

3. 扩展机制：DRF-Spectacular的扩展会识别PaginationWrapper，并在生成Schema时正确处理分页结构。

使用示例

将上述方案集成到自定义的AutoSchema中：

class CustomAutoSchema(AutoSchema):
    def get_response_serializers(self):
        serializer_class = get_class(self._get_serializer())
        return paginated_enveloper(
            serializer_class=serializer_class,
            many=self._is_list_view(serializer_class)

最终效果

使用此方案后，API响应将保持以下结构：

{
  "status": true,
  "detail": "Success",
  "code": 200,
  "data": {
    "count": 123,
    "next": "...",
    "previous": "...",
    "results": [...]
  }
}

注意事项

1. 确保已正确配置DRF的分页设置
2. 此方案依赖于DRF-Spectacular的扩展机制，需要确保扩展已正确安装和配置
3. 对于非分页的响应，可以继续使用简单的封装器

通过这种方案，开发者可以在保持API响应统一格式的同时，不丢失任何功能特性，为前端开发提供更加规范的接口。