目录
[方法1：使用 SchemaFilter](#方法1：使用 SchemaFilter)
[1、创建自定义 SchemaFilter](#1、创建自定义 SchemaFilter)
[2、在 Swagger 配置中使用该 Filter](#2、在 Swagger 配置中使用该 Filter)
[方法2：使用 OperationFilter 或 DocumentFilter](#方法2：使用 OperationFilter 或 DocumentFilter)
[1、创建自定义 OperationFilter](#1、创建自定义 OperationFilter)
[2、在 Swagger 配置中使用该 Filter](#2、在 Swagger 配置中使用该 Filter)
如果您喜欢此文章，请收藏、点赞、评论，谢谢，祝您快乐每一天。
在使用 Swagger 与 C# 一起工作时，特别是在使用诸如 Swashbuckle.AspNetCore 这样的库时，确保数据类型正确映射非常重要，尤其是在处理像 long 这样的数值类型时。如果你需要将 long 类型转换为 string 类型以避免精度丢失问题，你可以通过自定义 Swagger 生成逻辑来实现这一点。
解决方案
方法1：使用 SchemaFilter
你可以创建一个自定义的 ISchemaFilter 来改变属性的 Schema 类型。例如，如果你想将某个 long 类型的属性转换为 string 类型，可以创建一个自定义的 SchemaFilter。
1、创建自定义 SchemaFilter
首先，创建一个实现 ISchemaFilter 的类：
using Swashbuckle.AspNetCore.SwaggerGen;
using Microsoft.OpenApi.Models;
using System.Collections.Generic;
using System.Linq;
public class LongToStringSchemaFilter : ISchemaFilter
{
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (context.Type == typeof(long))
{
schema.Type = "string";
schema.Format = "int64"; // 如果需要保持数值格式，可以指定为 "int64"
}
}
}
2、在 Swagger 配置中使用该 Filter
在配置 Swagger 时，使用这个过滤器：
services.AddSwaggerGen(c =>
{
c.SchemaFilter<LongToStringSchemaFilter>(); // 应用自定义过滤器
// 其他配置...
});
方法2：使用 OperationFilter 或 DocumentFilter
如果你需要更细粒度的控制，比如在特定操作上转换类型，可以使用 OperationFilter 或 DocumentFilter。例如，使用 OperationFilter：
1、创建自定义 OperationFilter
using Swashbuckle.AspNetCore.SwaggerGen;
using Microsoft.OpenApi.Models;
using System.Collections.Generic;
using System.Linq;
public class LongToStringOperationFilter : IOperationFilter
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
var parametersToChange = context.MethodInfo.GetParameters()
.Where(p => p.ParameterType == typeof(long))
.Select(p => p.Name)
.ToList();
foreach (var param in operation.Parameters)
{
if (parametersToChange.Contains(param.Name))
{
param.Schema.Type = "string";
param.Schema.Format = "int64"; // 如果需要保持数值格式，可以指定为 "int64"
}
}
}
}
2、在 Swagger 配置中使用该 Filter
services.AddSwaggerGen(c =>
{
c.OperationFilter<LongToStringOperationFilter>(); // 应用自定义过滤器
// 其他配置...
});
总结
通过上述任一方法，你可以在 Swagger 中将 long 类型的参数或属性转换为 string 类型，从而避免精度丢失问题。选择哪种方法取决于你的具体需求，比如是否需要全局转换还是仅在特定操作上转换。
如果您喜欢此文章，请收藏、点赞、评论，谢谢，祝您快乐每一天。