首页
/ FastEndpoints项目中的Swagger文档配置支持IServiceProvider解析

FastEndpoints项目中的Swagger文档配置支持IServiceProvider解析

2025-06-08 17:21:50作者:胡唯隽

在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();

技术优势

  1. 生命周期安全:避免了手动构建服务提供者可能导致的瞬时服务被意外提升为单例的问题
  2. 配置灵活性:可以在文档配置阶段动态获取配置值或其他服务
  3. 代码整洁性:保持了依赖注入的最佳实践,无需引入特殊处理逻辑

适用场景

这一改进特别适用于以下情况:

  • 需要根据配置值动态设置Swagger文档属性
  • 在文档配置阶段需要访问数据库或其他服务
  • 实现基于环境或条件的差异化文档配置

总结

FastEndpoints项目通过暴露DocumentOptions.Services属性,为Swagger文档配置提供了更符合.NET Core设计模式的服务解析方式。这一改进不仅提升了开发体验,也确保了服务生命周期的正确管理,是框架向更完善方向发展的重要一步。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
166
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
88
568
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
17
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
cjoycjoy
一个高性能、可扩展、轻量、省心的仓颉应用开发框架。IoC,Rest,宏路由,Json,中间件,参数绑定与校验,文件上传下载,OAuth2,MCP......
Cangjie
94
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
954
564