FastStream框架中Discriminated Unions的AsyncAPI生成问题解析

问题背景

在使用FastStream框架开发基于RabbitMQ的消息服务时，开发者可能会遇到一个与Pydantic的Discriminated Unions相关的AsyncAPI文档生成问题。当尝试使用带有Field(discriminator=...)注解的联合类型时，系统会抛出AttributeError: 'list' object has no attribute 'items'错误，导致无法生成API文档。

技术细节分析

这个问题源于FastStream框架在处理Pydantic的Discriminated Unions时的一个实现缺陷。Discriminated Unions是Pydantic提供的一种特殊联合类型，它通过一个明确的字段(通常是字符串字面量)来区分不同的子类型。

在示例代码中，开发者定义了两个模型Hotdog和Sub，它们都有一个type字段作为区分标识。然后使用Annotated和Field(discriminator="type")创建了一个联合类型MyTypeUnion。当FastStream尝试为这个端点生成AsyncAPI文档时，内部处理逻辑出现了类型判断错误。

问题重现

以下是典型的问题重现场景：

class Hotdog(BaseModel):
    type: Literal["hotdog"]
    condiments: list[str]

class Sub(BaseModel):
    type: Literal["sub"]
    condiments: list[str]
    bread: Literal["white", "wheat"]

MyTypeUnion = Annotated[ Hotdog | Sub, Field(discriminator="type")]

@broker.subscriber("test_queue")
async def handle_event(msg_body: MyTypeUnion) -> None:
    print(msg_body)

当执行faststream docs gen命令时，框架会抛出异常，因为它在处理oneOf结构时错误地将列表当作字典处理。

解决方案与变通方法

目前有两种可行的解决方案：

1. 移除discriminator注解：使用普通的联合类型而非Discriminated Unions

MyTypeUnion = Annotated[ Hotdog | Sub, Field(union="smart")]

2. 将联合类型嵌套在更高层模型中：通过包装模型来规避直接使用Discriminated Unions的问题

技术影响

这个问题影响了开发者使用Pydantic高级类型特性的能力，特别是在需要明确区分不同消息类型的场景下。Discriminated Unions在API设计中非常有用，因为它可以：

• 提供明确的类型区分机制
• 在运行时确保消息结构的正确性
• 生成更精确的API文档

开发者建议

对于遇到此问题的开发者，建议：

1. 暂时使用普通联合类型作为临时解决方案
2. 关注FastStream的版本更新，该问题已被标记为bug并正在修复中
3. 在复杂类型场景下，考虑将消息体设计为包含类型字段的单一模型，而非使用联合类型

这个问题展示了在使用新兴框架时可能遇到的高级特性兼容性问题，也提醒我们在设计消息协议时要考虑工具链的完整支持情况。