FastEndpoints中处理Swagger将GUID类型映射为UUID的方法

在FastEndpoints项目中，开发者经常遇到需要将C#中的GUID类型在Swagger文档中正确显示为UUID格式的需求。本文将详细介绍如何通过配置实现这一功能。

问题背景

在API开发中，GUID（全局唯一标识符）是一种常用的数据类型。然而，当使用Swagger生成API文档时，默认情况下GUID类型可能被简单地识别为字符串类型，而不是更精确的UUID格式。这会导致在使用Kiota等工具生成客户端代码时，无法正确识别GUID类型，影响开发效率。

解决方案

FastEndpoints提供了灵活的配置选项，可以通过TypeMapper机制来解决这个问题。具体实现方法如下：

1. 使用PrimitiveTypeMapper：这是一种专门用于映射基本类型的映射器
2. 配置SchemaSettings：在Swagger文档设置中添加类型映射器
3. 指定格式：将GUID类型映射为字符串类型，并设置格式为"uuid"

实现代码

以下是具体的配置代码示例：

.SwaggerDocument(
   o => o.DocumentSettings =
            s => s.SchemaSettings.TypeMappers.Add(
                new PrimitiveTypeMapper(
                    typeof(Guid),
                    schema =>
                    {
                        schema.Type = JsonObjectType.String;
                        schema.Format = "uuid";
                    })));

效果说明

配置完成后，Swagger文档中将正确显示GUID字段为UUID格式，而不是普通的字符串类型。这带来以下好处：

1. 客户端代码生成更准确：使用Kiota等工具生成客户端代码时，会正确识别为UUID类型
2. API文档更规范：符合OpenAPI规范中对UUID类型的定义
3. 前后端协作更顺畅：前后端开发人员对数据类型有更明确的共识

注意事项

1. 此配置应在应用程序启动时完成
2. 确保使用的FastEndpoints版本支持TypeMapper功能
3. 对于复杂类型中包含的GUID属性，此映射同样有效

通过这种配置方式，开发者可以轻松解决GUID类型在Swagger文档中的表示问题，提升API开发的一致性和效率。