ASP.NET Core 中实现 OpenAPI 文档的蛇形命名规范
2025-05-03 12:03:58作者:裴锟轩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));
注意事项
-
目前 Microsoft.AspNetCore.OpenApi 包不支持 Newtonsoft.Json,只能使用 System.Text.Json 进行序列化。
-
对于查询参数,如果需要蛇形命名,可以添加自定义的 ValueProviderFactory:
builder.Services.AddControllers(options =>
{
options.ValueProviderFactories.Add(new SnakeCaseQueryValueProviderFactory());
});
通过以上配置,我们可以确保 API 的请求和响应数据都使用蛇形命名规范,同时生成的 OpenAPI 文档也会正确反映这一命名风格。这种统一的命名规范有助于提高 API 的可用性和一致性,特别是在多语言环境中使用时。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~044CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0300- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选
收起

React Native鸿蒙化仓库
C++
176
261

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511

🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15

openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300

deepin linux kernel
C
22
5

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
595
57

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K