有没有一种方法可以更改DRF-Spectacular中序列化器的自动化shema名称

Question

我得到了许多名为“ InputSerializer”和“ OutputSerializer”的序列化器，它们在DRF-Spectacular中转化为“输入”和“输出”模式名称。这最终将API端点引用到同一模式。有没有一种方法可以覆盖这些连续剧器的自动化架构名称而不更改班级名称？

Answer 1

我遇到了一堆，但从未尝试过解决它。查看我找到的文档 Extended_schema_serializer ，可能会做您需要的事情。这是

• component_name - 覆盖默认的类名称提取

@extended_schema_serializer(component_name="SomeNiceReallyLongId")
class Input(Serializer):
    # pass

其较长而丑陋，但可以由装饰器上的装饰器修复：d

eding ：

我最终实现了这一点。这是我写的小包装纸。这只是使序列化和字段之间的较短和一致的事情。

您可以在序列化器上多次使用extended_schema_serializer，因此不会破坏任何内容。

@oapi.name("UserEditRequest")
@extend_schema_serializer(examples=[]) # other settings
class EditSerializer(ModelSerializer):
    pass

# oapi.py
from drf_spectacular.utils import set_override as _set_override

def name(val: str):
    def decorator(klass):
        if issubclass(klass, BaseSerializer):
            _set_override(klass, "component_name", val)
        elif isinstance(klass, Field):
            _set_override(klass, "field_component_name", val)
        else:
            raise Exception(f"Unhandled class: {klass}")

        return klass

    return decorator

Answer 2

可以理解的，但是一个独特的名称必须来自某个地方，而壮观的名字不知道什么是classname本身对您来说是什么好名字。
安德鲁（Andrew）提供了天然溶液，但也有句法糖（与DRF-YASG的兼容性特征）。

class InputSerializer(serializer.Serializer):

    class Meta:
        ref_name = 'SomeNiceReallyLongId'

否则，我建议子分类autoschema和覆盖 _get_serializer_name _get_serialize_name ，并使其适合您。