首页
/ FastEndpoints项目中自定义Swagger URL前缀的配置方法

FastEndpoints项目中自定义Swagger URL前缀的配置方法

2025-06-08 19:24:44作者:乔或婵

在FastEndpoints项目中,开发者经常需要为Swagger UI和API文档配置自定义的URL前缀,以满足特定的部署需求或组织架构要求。本文将详细介绍如何通过配置实现这一功能。

为什么需要自定义Swagger URL前缀

在实际项目部署中,我们可能需要:

  1. 将Swagger UI部署在特定前缀路径下,与其他应用区分
  2. 符合企业内部API网关的路由规则
  3. 实现多版本API文档共存
  4. 满足安全策略要求,将文档访问路径隔离

完整配置方案

FastEndpoints提供了灵活的配置方式,可以同时修改Swagger UI和API文档的访问路径:

app.UseSwaggerGen(
    s =>
    {
        // 配置Swagger JSON文件的访问路径
        s.Path = "/PREFIX/swagger/{documentName}/swagger.json";

        // 自定义API端点服务器基础路径
        s.PostProcess = (document, request) =>
        {
            document.Servers.Clear();
            document.Servers.Add(
                new()
                {
                    Url = $"{request.Scheme}://{request.Host}/PREFIX"
                });
        };
    },
    ui =>
    {
        // 配置Swagger UI的访问路径
        ui.Path = "/PREFIX/swagger";

        // 配置Swagger UI查找JSON文件的路径
        ui.DocumentPath = "/PREFIX/swagger/{documentName}/swagger.json";
    });

配置项详解

  1. Swagger JSON配置部分

    • Path:指定Swagger生成的JSON描述文件的访问路径
    • PostProcess:用于动态修改生成的OpenAPI文档,这里我们重写了服务器URL
  2. Swagger UI配置部分

    • Path:设置Swagger UI的根访问路径
    • DocumentPath:告诉Swagger UI从何处加载API描述文件

实际应用示例

假设我们需要将API文档部署在/api-docs前缀下:

app.UseSwaggerGen(
    s =>
    {
        s.Path = "/api-docs/swagger/{documentName}/swagger.json";
        s.PostProcess = (document, request) =>
        {
            document.Servers.Clear();
            document.Servers.Add(new() { Url = $"{request.Scheme}://{request.Host}/api-docs" });
        };
    },
    ui =>
    {
        ui.Path = "/api-docs/swagger";
        ui.DocumentPath = "/api-docs/swagger/{documentName}/swagger.json";
    });

注意事项

  1. 确保所有路径配置中的前缀保持一致
  2. 如果使用网络中间件,可能需要额外配置路由规则
  3. 在生产环境中,建议限制Swagger UI的访问权限
  4. 路径修改后,相关的书签和文档链接也需要相应更新

通过以上配置,开发者可以灵活地将FastEndpoints项目的API文档部署在任何需要的路径前缀下,满足各种复杂的部署场景需求。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511