解决drf-spectacular与djangorestframework-simplejwt的兼容性问题

在使用Django REST framework开发API时，drf-spectacular是一个非常流行的自动生成OpenAPI/Swagger文档的工具。而djangorestframework-simplejwt则是实现JWT认证的常用库。本文将介绍如何解决这两个库在集成时可能遇到的兼容性问题。

问题现象

当开发者在Django项目的settings.py中同时配置了drf-spectacular和djangorestframework-simplejwt时，可能会遇到API文档无法加载的问题，并出现TypeError: 'str' object is not callable的错误提示。

问题根源

这个问题的根本原因在于REST_FRAMEWORK配置中的DEFAULT_AUTHENTICATION_CLASSES设置错误。开发者错误地使用了字典（Dictionary）而不是元组（Tuple）或列表（List）来定义认证类。

错误配置示例：

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    'DEFAULT_AUTHENTICATION_CLASSES': {  # 错误：使用了字典
        'rest_framework_simplejwt.authentication.JWTAuthentication'
    }
}

正确配置方法

Django REST framework要求DEFAULT_AUTHENTICATION_CLASSES必须是一个可迭代的序列（如元组或列表），因为可能有多个认证类需要配置。正确的配置应该是：

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    'DEFAULT_AUTHENTICATION_CLASSES': (  # 使用元组
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    )
}

或者使用列表：

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    'DEFAULT_AUTHENTICATION_CLASSES': [  # 使用列表
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ]
}

为什么会出现这个错误

当Django REST framework尝试初始化认证类时，它会遍历DEFAULT_AUTHENTICATION_CLASSES中的每个元素，并尝试调用它们（即执行auth()）。如果DEFAULT_AUTHENTICATION_CLASSES是一个字典，遍历时得到的将是字典的键（字符串），而不是认证类本身，因此会出现"str对象不可调用"的错误。

最佳实践建议

1. 始终使用元组或列表来定义DEFAULT_AUTHENTICATION_CLASSES
2. 确保drf-spectacular版本是最新的（在撰写本文时最新版本是0.26.5）
3. 如果使用多个认证类，确保它们之间有适当的顺序
4. 考虑在开发环境中保留SessionAuthentication以便于测试

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework_simplejwt.authentication.JWTAuthentication',
        'rest_framework.authentication.SessionAuthentication',  # 开发时方便测试
    ]
}

通过以上配置，drf-spectacular将能够正确生成包含JWT认证支持的OpenAPI文档，开发者也可以在Swagger UI中方便地测试JWT认证的API端点。