You need to enable JavaScript to run this app. 如何在.NET Web API项目中禁用或关闭Swagger功能?
优惠活动
大模型
产品
解决方案
定价
更多

如何在.NET Web API项目中禁用或关闭Swagger功能?

.NET Web API 关闭/移除Swagger功能的操作方法

以下按两种常见使用场景给出操作步骤:

场景1:仅临时关闭Swagger(保留依赖,后续可随时恢复)

根据你使用的.NET版本对应操作即可:

  • .NET 6及更高版本(Program.cs使用顶层语句)
    1. 打开Program.cs文件,注释或删除Swagger相关的注册和中间件代码:
    // 注释掉Swagger服务注册代码
    // builder.Services.AddSwaggerGen();
    
    // 注释掉Swagger中间件配置
    // if (app.Environment.IsDevelopment())
    // {
    //     app.UseSwagger();
    //     app.UseSwaggerUI();
    // }
    
    1. 打开项目下Properties/launchSettings.json文件,将所有配置节点下的launchUrl字段值从swagger修改为空,或者你需要的默认启动路由:
    "launchUrl": "",
    
  • .NET 5及更早版本(使用Startup.cs分离配置)
    1. 打开Startup.cs文件,注释或删除ConfigureServices方法中的services.AddSwaggerGen();代码
    2. 注释或删除Configure方法中的app.UseSwagger()、app.UseSwaggerUI()相关代码
    3. 同上修改launchSettings.json中的launchUrl参数即可

场景2:完全移除Swagger相关组件(后续不会再使用)

  1. 卸载Swagger相关Nuget包:
  • 包管理器控制台执行命令:
Uninstall-Package Swashbuckle.AspNetCore
  • .NET CLI执行命令:
dotnet remove package Swashbuckle.AspNetCore
  1. 按照场景1的步骤,删除Program.cs/Startup.cs中所有Swagger相关的代码
  2. 修改launchSettings.json的launchUrl配置即可

内容的提问来源于stack exchange,提问作者user16168859

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.15 19:15:09