FastEndpoints项目中的Swagger文档配置支持IServiceProvider解析
2025-06-08 05:53:12作者:胡唯隽
在FastEndpoints项目的Swagger文档配置中,开发者现在可以通过DocumentOptions.Services属性获取IServiceProvider实例,这一改进使得在配置阶段能够安全地解析依赖服务。
背景与需求
在ASP.NET Core应用中,Swagger文档配置通常需要在应用启动阶段完成。传统方式下,开发者若要在配置过程中访问已注册的服务(如配置选项IOptions、日志服务等),往往需要手动构建服务提供者(BuildServiceProvider),这种做法不仅不够优雅,还可能导致服务生命周期管理问题。
解决方案实现
FastEndpoints从v5.33.0.8-beta版本开始,通过DocumentOptions.Services属性提供了对IServiceProvider的直接访问能力。这一设计使得开发者可以在配置Swagger文档时,自然地解析所需服务,而无需绕过依赖注入系统。
使用示例
以下代码展示了如何在FastEndpoints项目中利用这一特性:
var bld = WebApplication.CreateBuilder(args);
bld.Services.Configure<YourConfigClass>(bld.Configuration.GetSection(nameof(YourConfigClass)));
bld.Services
.SwaggerDocument(
o =>
{
// 通过DocumentOptions.Services获取服务
var conf = o.Services.GetRequiredService<IOptions<YourConfigClass>>();
o.DocumentSettings = doc =>
{
doc.DocumentName = conf.Value.DocName;
};
})
.AddFastEndpoints();
var app = bld.Build();
app.UseFastEndpoints()
.UseSwaggerGen();
app.Run();
技术优势
- 生命周期安全:避免了手动构建服务提供者可能导致的瞬时服务被意外提升为单例的问题
- 配置灵活性:可以在文档配置阶段动态获取配置值或其他服务
- 代码整洁性:保持了依赖注入的最佳实践,无需引入特殊处理逻辑
适用场景
这一改进特别适用于以下情况:
- 需要根据配置值动态设置Swagger文档属性
- 在文档配置阶段需要访问数据库或其他服务
- 实现基于环境或条件的差异化文档配置
总结
FastEndpoints项目通过暴露DocumentOptions.Services属性,为Swagger文档配置提供了更符合.NET Core设计模式的服务解析方式。这一改进不仅提升了开发体验,也确保了服务生命周期的正确管理,是框架向更完善方向发展的重要一步。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust098- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiMo-V2.5-ProMiMo-V2.5-Pro作为旗舰模型,擅⻓处理复杂Agent任务,单次任务可完成近千次⼯具调⽤与⼗余轮上 下⽂压缩。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
项目优选
收起
deepin linux kernel
C
28
16
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
568
98
暂无描述
Dockerfile
709
4.51 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
958
955
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.61 K
942
Ascend Extension for PyTorch
Python
572
694
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
413
339
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.42 K
116
暂无简介
Dart
951
235
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
2