FastEndpoints中FromBody类型请求DTO的Swagger示例值问题解析

问题背景

在使用FastEndpoints框架开发API时，开发者可能会遇到一个关于Swagger文档生成的问题：当请求DTO中包含通过[FromBody]绑定的复杂类型时，预先定义的XML文档示例值（<example>标签）无法正确显示在Swagger的示例请求中。

问题现象

具体表现为：

1. 当请求DTO直接作为JSON绑定的主体时，XML文档中的示例值能正常显示
2. 但当DTO中包含[FromBody]标记的复杂类型属性时：
   • 该复杂类型内部的示例值不会出现在Swagger UI中
   • 尝试使用EndpointSummary.ExampleRequest作为替代方案也会失效

技术分析

这个问题源于FastEndpoints的Swagger集成层在处理嵌套的FromBody类型时，没有正确地将XML文档中的示例值传递到生成的OpenAPI规范中。本质上是一个元数据传递的缺失问题。

解决方案

该问题已在FastEndpoints v5.29.0.7-beta版本中修复。现在开发者可以按照以下方式正常使用：

public sealed class Request
{
    ///<example>12345</example>
    public string Id { get; set; }

    [FromBody]
    public Person Person { get; set; }
}

public sealed class Person
{
    ///<example>johnny</example>
    public string FirstName { get; set; }

    ///<example>doe</example>
    public string LastName { get; set; }
}

public sealed class MyEndpoint : Endpoint<Request>
{
    public override void Configure()
    {
        Post("test");
        AllowAnonymous();
    }
}

修复后，Swagger UI将正确显示：

• 顶层ID字段的示例值"12345"
• Person对象中FirstName的示例值"johnny"
• Person对象中LastName的示例值"doe"

高级用法

如果需要覆盖XML文档中定义的示例值，仍然可以使用Summary配置：

Summary(s => s.ExampleRequest = new Person { 
    FirstName = "JANE", 
    LastName = "DOE" 
});

最佳实践建议

1. 对于简单的示例值，优先使用XML文档注释
2. 对于需要动态生成或复杂结构的示例，使用ExampleRequest配置
3. 保持DTO结构的清晰性，避免过深的嵌套层次
4. 及时更新到最新版本以获取最佳体验

总结

这个修复使得FastEndpoints在Swagger文档生成方面更加完善，特别是对于复杂请求结构的API。开发者现在可以更灵活地控制API文档中的示例数据，无论是通过声明式的XML注释还是编程式的配置方式，都能获得一致的表现。