如何在drf_spectacular (django)中发送带有请求的自定义JSON头？

在Django REST Framework (DRF) 中使用 drf-spectacular 生成 API 文档时，如果你想要发送带有自定义 JSON 头的请求，可以通过以下步骤实现：

基础概念

自定义 JSON 头：指的是在 HTTP 请求中添加非标准的头部信息，通常用于传递额外的数据或身份验证信息。
DRF：Django REST Framework 是一个强大的且灵活的工具包，用于构建 Web API。
drf-spectacular：是一个用于生成 OpenAPI 文档的工具，它基于 DRF 构建。

类型

请求头：HTTP 请求中的头部信息，用于传递元数据。

应用场景

身份验证：使用自定义头传递 API 密钥或令牌。
版本控制：通过自定义头来指定 API 版本。

如何发送带有自定义 JSON 头的请求

1. 在视图中处理自定义头

首先，你需要在 DRF 视图中处理自定义头。例如：

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

class CustomHeaderView(APIView):
    def get(self, request, format=None):
        custom_header = request.META.get('HTTP_X_CUSTOM_HEADER')
        return Response({'custom_header': custom_header})

2. 在序列化器中添加自定义头

如果你需要在序列化器中使用自定义头，可以在序列化器中进行处理。

3. 在测试中发送带有自定义头的请求

在编写测试时，你可以使用 APIClient 发送带有自定义头的请求：

from rest_framework.test import APITestCase, APIClient

class CustomHeaderTests(APITestCase):
    def setUp(self):
        self.client = APIClient()

    def test_custom_header(self):
        response = self.client.get('/custom-header/', HTTP_X_CUSTOM_HEADER='test_value')
        self.assertEqual(response.status_code, 200)
        self.assertEqual(response.data['custom_header'], 'test_value')

遇到的问题及解决方法

问题：自定义头在请求中未生效

原因：可能是由于自定义头的名称不正确，或者在请求中没有正确设置。

解决方法：

确保自定义头的名称在代码中与请求中一致。
使用 HTTP_X_CUSTOM_HEADER 格式来访问自定义头。

问题：drf-spectacular 未生成自定义头的文档

原因：drf-spectacular 默认不会自动检测自定义头，需要手动添加。

解决方法：

在视图中使用 @extend_schema 装饰器来手动添加自定义头信息：

from drf_spectacular.utils import extend_schema, extend_schema_view
from drf_spectacular.types import OpenApiTypes

@extend_schema(request=None, responses={200: {'type': 'object', 'properties': {'custom_header': {'type': 'string'}}}})
@extend_schema_view(get=CustomHeaderView.get)
class CustomHeaderView(APIView):
    def get(self, request, format=None):
        custom_header = request.META.get('HTTP_X_CUSTOM_HEADER')
        return Response({'custom_header': custom_header})