DRF-Spectacular中处理PDF响应类型的正确方式

在使用Django REST framework (DRF) 和其API文档生成工具drf-spectacular时，开发者可能会遇到一个常见问题：如何正确地配置视图以支持返回PDF格式的响应。本文将通过一个典型场景，深入分析问题原因并提供解决方案。

问题场景

假设我们有一个DRF视图集，其中包含一个返回PDF报告的自定义action。开发者尝试使用drf-spectacular的@extend_schema装饰器来明确指定这个action返回的是PDF格式的二进制数据：

@extend_schema(responses={(200, "application/pdf"): OpenApiTypes.BINARY})
@action(methods=("get",), detail=True, url_path="pdf-report")
def pdf_report(...)

然而，当通过Swagger UI测试这个端点时，却收到了"Could not satisfy the request Accept header"的错误。

问题分析

这个问题的根源在于DRF的请求处理机制和drf-spectacular的职责分工：

1. drf-spectacular的作用：它仅负责生成API文档（schema），不会修改API的实际行为。@extend_schema装饰器只是告诉文档生成器这个端点会返回PDF格式的数据。

2. DRF的渲染器机制：DRF默认情况下可能没有配置处理application/pdf的渲染器。当客户端请求PDF格式时，DRF会检查其renderer_classes中是否包含能处理该格式的渲染器，如果没有就会拒绝请求。

解决方案

要解决这个问题，我们需要在DRF层面正确配置PDF渲染器。以下是两种可行的方案：

方案一：自定义渲染器类

创建一个简单的PDF渲染器类，明确声明它能处理的媒体类型：

from rest_framework.renderers import BaseRenderer

class PDFRenderer(BaseRenderer):
    media_type = 'application/pdf'
    format = 'pdf'
    charset = None
    render_style = 'binary'

    def render(self, data, media_type=None, renderer_context=None):
        return data

然后在视图中指定这个渲染器：

@extend_schema(responses={(200, "application/pdf"): OpenApiTypes.BINARY})
@action(methods=("get",), detail=True, url_path="pdf-report", 
        renderer_classes=[PDFRenderer])
def pdf_report(...)

方案二：使用APIView并配置渲染器

如果使用基于类的视图而不是视图集，可以这样配置：

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

class PDFReportView(APIView):
    renderer_classes = [PDFRenderer]
    
    @extend_schema(responses={(200, "application/pdf"): OpenApiTypes.BINARY})
    def get(self, request, *args, **kwargs):
        # 生成PDF的逻辑
        return Response(pdf_data, content_type='application/pdf')

最佳实践建议

1. 明确区分文档和实现：记住drf-spectacular只负责文档生成，API的实际行为由DRF控制。

2. 测试不同内容类型：在开发API时，应该测试各种Accept头的情况，确保API能正确处理所有声明的响应格式。

3. 考虑使用动态渲染器：对于需要支持多种格式的端点，可以考虑使用DRF的内容协商机制动态选择渲染器。

通过正确理解DRF的渲染器机制和drf-spectacular的文档生成原理，开发者可以轻松解决这类内容类型协商问题，构建出既文档完善又功能正确的API端点。