FastEndpoints项目中解决Swagger文档中nullable类型显示为OneOf的问题

在FastEndpoints项目中，当使用Swagger生成API文档时，开发者可能会遇到一个常见问题：nullable类型（可空类型）在Swagger UI中会以"OneOf"的形式展示，而不是直接显示为可空属性。这种情况虽然不影响功能，但会导致API文档不够直观，影响开发者体验。

问题现象

当我们在FastEndpoints项目中定义DTO（数据传输对象）时，如果某个属性被声明为可空类型（例如Person?），在生成的Swagger文档中，该属性会显示为"OneOf"结构，表示它可以是null或者Person对象。这与我们期望的直接显示为可空属性的方式不同。

例如，对于以下DTO定义：

sealed class Request
{
    public string Id { get; set; }
    public Person? Person { get; set; }
}

在Swagger UI中会显示为：

Person: OneOf
  - null
  - Person

而不是更直观的：

Person: Person (nullable)

问题原因

这个问题实际上源于NSwag（FastEndpoints底层使用的Swagger生成库）的默认行为。NSwag在处理可空引用类型时，会将其转换为一个"OneOf"结构，表示该属性可以是null或者指定类型的实例。

解决方案

FastEndpoints提供了配置选项来修改这一行为。我们可以通过设置NSwag的SchemaSettings来改变可空类型的展示方式：

bld.Services
   .AddFastEndpoints()
   .SwaggerDocument(d => d.DocumentSettings = s => s.SchemaSettings.AllowReferencesWithProperties = true);

这个配置告诉NSwag允许引用类型保留它们的属性，而不是将它们转换为"OneOf"结构。启用后，可空属性将直接显示为可空类型，使API文档更加清晰易读。

最佳实践

1. 一致性：在整个项目中保持一致的Swagger文档风格，要么全部使用"OneOf"表示可空性，要么全部直接显示为可空属性。

2. 文档清晰性：对于大多数项目，直接显示为可空属性更符合开发者的直觉，推荐使用上述配置。

3. 版本兼容性：注意此配置在不同版本的NSwag中可能有不同的表现，升级NSwag版本时需要验证此功能是否仍然有效。

4. 团队沟通：如果团队已经习惯了"OneOf"的表示方式，或者有特殊需求，可以保留默认行为。

通过理解这个问题及其解决方案，开发者可以更好地控制FastEndpoints项目生成的Swagger文档格式，提升API文档的可读性和一致性。