如何为DRF固定字符串响应生成drf-spectacular schema？

针对你遇到的「大量接口返回固定消息，但手动加@extend_schema太繁琐」的问题，这里提供几个更高效的解决方案：

1. 自定义固定响应Serializer + 视图Mixin #

先封装通用Serializer，再用Mixin统一处理响应和Schema逻辑：

# serializers.py
from rest_framework import serializers

class FixedMessageSerializer(serializers.Serializer):
    message = serializers.CharField(example="Your request has been accepted")

# mixins.py
from rest_framework.response import Response
from drf_yasg.utils import swagger_auto_schema

class FixedResponseMixin:
    fixed_message = "Your request has been accepted"
    response_serializer = FixedMessageSerializer

    @swagger_auto_schema(responses={200: response_serializer})
    def post(self, request, *args, **kwargs):
        # 插入你的业务逻辑
        return Response({"message": self.fixed_message})

    # 若GET方法也需固定响应，同理重写get方法即可

使用时让视图继承该Mixin，还能自定义消息：

class YourAPIView(FixedResponseMixin, APIView):
    fixed_message = "Your POST request is accepted successfully"

    def post(self, request):
        # 业务代码
        return super().post(request)

优点：逻辑复用性强，视图代码简洁，自定义消息灵活。

2. 重写OpenAPI Schema生成器 #

通过自定义Schema生成器，自动识别带标记的视图，批量更新Schema内容：

# schema.py
from rest_framework.schemas.openapi import SchemaGenerator

class FixedResponseSchemaGenerator(SchemaGenerator):
    def get_operation(self, path, method):
        operation = super().get_operation(path, method)
        view = self.view_for_path(path, method)

        # 检查视图是否声明了固定响应消息
        if hasattr(view, "fixed_response_message"):
            # 替换200状态码的响应Schema
            operation["responses"]["200"]["content"]["application/json"]["schema"] = {
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string",
                        "example": view.fixed_response_message
                    }
                },
                "required": ["message"]
            }
        return operation

在DRF配置中指定该生成器：

# settings.py
REST_FRAMEWORK = {
    "DEFAULT_SCHEMA_CLASS": "your_app.schema.FixedResponseSchemaGenerator",
}

视图中仅需添加一个标记属性：

class YourAPIView(APIView):
    fixed_response_message = "Your request has been accepted"

    def post(self, request):
        # 业务代码
        return Response({"message": self.fixed_response_message})

优点：无需修改视图方法逻辑，仅通过标记属性实现批量更新，侵入性极低。

3. 批量装饰器工具 #

如果不想改动视图继承结构，可写批量装饰函数统一添加Schema配置：

# utils.py
from drf_yasg.utils import swagger_auto_schema
from drf_yasg import openapi

def apply_fixed_response(view_class, message="Your request has been accepted"):
    # 装饰POST方法
    original_post = view_class.post
    decorated_post = swagger_auto_schema(
        responses={
            200: openapi.Response(
                description="Success",
                schema=openapi.Schema(
                    type=openapi.TYPE_OBJECT,
                    properties={
                        "message": openapi.Schema(type=openapi.TYPE_STRING, example=message)
                    }
                )
            )
        }
    )(original_post)
    view_class.post = decorated_post

    # 若需处理GET方法，重复上述逻辑即可
    return view_class

使用时在视图注册处批量处理：

# views.py或urls.py
from .views import OrderAPIView, PaymentAPIView

# 给单个视图添加固定响应Schema
OrderAPIView = apply_fixed_response(OrderAPIView)
# 自定义消息
PaymentAPIView = apply_fixed_response(PaymentAPIView, message="Payment request received")

优点：灵活适配现有视图结构，无需修改视图代码，适合快速批量改造。

内容的提问来源于stack exchange，提问作者Sachin M S