FastEndpoints项目中多态响应与Swagger集成的技术解析

背景介绍

在FastEndpoints项目中，开发者经常需要处理API端点返回多态响应的情况。多态响应指的是同一个API端点可能返回不同类型的对象，但这些对象共享某些共同特性。这种场景在面向对象编程中十分常见，但在Web API设计和文档化时却面临一些挑战。

问题描述

当开发者尝试使用FastEndpoints的TypedResults特性定义多态响应时，例如：

Results<Ok<SubAreaContractProfileData>, Ok<DirectProcurementContractProfileData>, NotFound>

期望在Swagger文档中看到使用OpenAPI的oneOf结构展示这两种可能的响应类型。然而实际行为是：

1. 默认情况下Swagger只显示最后一个Ok模型
2. 即使添加了JsonPolymorphic属性，生成的文档结构也不完全符合预期
3. 存在类型循环引用问题

技术分析

多态响应处理机制

FastEndpoints底层依赖于System.Text.Json(STJ)进行序列化，而STJ需要明确的属性标注来处理多态类型：

[JsonPolymorphic(TypeDiscriminatorPropertyName = "_t")]
[JsonDerivedType(typeof(SubAreaContractProfileData), "a")]
[JsonDerivedType(typeof(DirectProcurementContractProfileData), "o")]
public record ContractProfileData

这种标注方式确保了：

1. 序列化时能正确识别具体类型
2. 反序列化时能正确还原对象
3. 生成类型鉴别器字段"_t"

Swagger文档生成

FastEndpoints 5.31.0.4-beta版本改进了Swagger文档生成，现在能正确产生oneOf结构。但需要注意：

1. 必须显式配置Swagger使用oneOf：

bld.Services
   .AddFastEndpoints()
   .SwaggerDocument(c => c.UseOneOfForPolymorphism = true);

2. 返回类型应使用基类，而非多个具体类型：

// 推荐方式
Results<Ok<ContractProfileData>, NotFound>

// 不推荐方式
Results<Ok<SubAreaContractProfileData>, Ok<DirectProcurementContractProfileData>, NotFound>

循环引用问题

当基类和派生类之间存在相互引用时，会导致Swagger文档中出现循环结构。解决方案包括：

1. 确保派生类使用allOf引用基类而非直接包含属性
2. 在Swagger配置中处理循环引用
3. 考虑简化类型层次结构

最佳实践

1. 明确类型层次：设计清晰的基类和派生类关系
2. 正确标注：使用JsonPolymorphic和JsonDerivedType属性
3. 统一返回：端点返回基类类型而非多个具体类型
4. Swagger配置：启用UseOneOfForPolymorphism选项
5. 避免循环：审慎设计类之间的关系，避免相互引用

示例代码

// 基类定义
[JsonPolymorphic(TypeDiscriminatorPropertyName = "type")]
[JsonDerivedType(typeof(Dog), "dog")]
[JsonDerivedType(typeof(Cat), "cat")]
public abstract class Animal
{
    public string Name { get; set; }
}

// 派生类
public class Dog : Animal
{
    public string Breed { get; set; }
}

public class Cat : Animal
{
    public bool IsIndoor { get; set; }
}

// 端点定义
sealed class AnimalEndpoint : EndpointWithoutRequest<Results<Ok<Animal>, NotFound>>
{
    public override void Configure()
    {
        Get("api/animals/{id}");
    }

    public override async Task<Results<Ok<Animal>, NotFound>> ExecuteAsync(CancellationToken ct)
    {
        // 根据条件返回不同派生类
        if (/* condition */)
            return TypedResults.Ok((Animal)new Dog());
        else
            return TypedResults.Ok((Animal)new Cat());
    }
}

总结

FastEndpoints提供了强大的多态响应支持，通过合理使用STJ属性和Swagger配置，可以生成符合OpenAPI规范的API文档。开发者需要注意类型层次设计、属性标注和Swagger配置的协调，才能获得最佳的多态API文档效果。