山海人工智能信息网

🌟Swagger驼峰命名规范 | ABP Swagger返回值变驼峰了

导读 在使用ABP框架结合Swagger时,你是否发现接口返回的数据字段突然变成了驼峰格式?虽然这可能是框架默认行为,但对一些团队来说,可能需要统...

在使用ABP框架结合Swagger时,你是否发现接口返回的数据字段突然变成了驼峰格式?虽然这可能是框架默认行为,但对一些团队来说,可能需要统一为下划线风格或其他格式。不用担心!以下是一些小技巧可以帮助你调整:

🔍 问题背景

默认情况下,Swagger会将C中的PascalCase字段转换为camelCase(驼峰)。比如`UserName`会被显示为`userName`。这对于前端开发者来说很友好,但如果后端与前端约定的是其他格式,则需要手动干预。

🔧 解决方案

1️⃣ 修改Swagger配置文件,在`services.AddSwaggerGen()`中添加自定义设置,比如禁用默认的属性映射规则。

```csharp

options.MapType(() => typeof(string), () => new OpenApiSchema { Type = "string", Format = "custom" });

```

2️⃣ 如果希望全局统一,可以在模型类上添加`[JsonPropertyName("原名")]`特性,明确指定字段名称。

💡 小贴士

- 配置前先确认团队内部是否有统一规范。

- 使用`AddControllers().AddNewtonsoftJson()`可以进一步优化JSON序列化行为。

🎉 通过以上方法,你可以轻松掌控Swagger返回数据的格式,让前后端协作更加顺畅!💼✨