首页
/ ASP.NET Core 中实现 OpenAPI 文档的蛇形命名规范

ASP.NET Core 中实现 OpenAPI 文档的蛇形命名规范

2025-05-03 20:20:24作者:裴锟轩Denise

在 ASP.NET Core 项目中,我们经常需要为 API 接口生成 OpenAPI 文档。一个常见的需求是将 JSON 数据格式中的属性名统一转换为蛇形命名(snake_case)风格,这在与某些前端框架或第三方服务交互时尤为重要。

配置 JSON 序列化选项

ASP.NET Core 提供了简单的方式来全局配置 JSON 序列化行为。我们可以通过 ConfigureHttpJsonOptions 方法来设置蛇形命名策略:

builder.Services.ConfigureHttpJsonOptions(options =>
{
    options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.SnakeCaseLower;
});

JsonNamingPolicy.SnakeCaseLower 是 .NET 内置的蛇形命名策略,它会自动将属性名转换为小写并用下划线分隔的形式,例如将 "userName" 转换为 "user_name"。

自定义蛇形命名策略

如果需要更灵活的控制,我们可以实现自定义的命名策略:

public class JsonSerializerSnakeCaseNamingPolicy : JsonNamingPolicy
{
    public override string ConvertName(string name)
    {
        // 使用正则表达式将驼峰命名转换为蛇形命名
        return Regex.Replace(name, @"(\w)([A-Z])", "$1_$2").ToLower();
    }
}

统一配置 JSON 序列化

为了保持代码整洁,我们可以将 JSON 序列化的配置提取为单独的方法:

static void ConfigureJsonSerializer(JsonSerializerOptions options)
{
    options.PropertyNamingPolicy = new JsonSerializerSnakeCaseNamingPolicy();
    options.Converters.Add(new JsonStringEnumConverter());
    options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
    options.WriteIndented = false;
    options.ReferenceHandler = ReferenceHandler.IgnoreCycles;
}

然后在服务配置中调用这个方法:

builder.Services.AddControllers()
    .AddJsonOptions(options => ConfigureJsonSerializer(options.JsonSerializerOptions));

builder.Services.ConfigureHttpJsonOptions(options => 
    ConfigureJsonSerializer(options.SerializerOptions));

注意事项

  1. 目前 Microsoft.AspNetCore.OpenApi 包不支持 Newtonsoft.Json,只能使用 System.Text.Json 进行序列化。

  2. 对于查询参数,如果需要蛇形命名,可以添加自定义的 ValueProviderFactory:

builder.Services.AddControllers(options =>
{
    options.ValueProviderFactories.Add(new SnakeCaseQueryValueProviderFactory());
});

通过以上配置,我们可以确保 API 的请求和响应数据都使用蛇形命名规范,同时生成的 OpenAPI 文档也会正确反映这一命名风格。这种统一的命名规范有助于提高 API 的可用性和一致性,特别是在多语言环境中使用时。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8