ASP.NET WebApi中如何修改Swagger的默认访问基础URL路径
ASP.NET Web API 修改Swagger访问路径的配置方案
ASP.NET Web API 有和ASP.NET Core类似的配置方式,无需额外引入依赖,直接修改原有Swagger配置即可实现路径自定义,操作步骤如下:
- 第一步:找到配置入口
项目中Swagger的配置默认定义在App_Start文件夹下的SwaggerConfig.cs文件的Register静态方法中,所有自定义规则都可以在此方法内修改。 - 第二步:修改路由配置
分别修改EnableSwagger(Swagger元数据接口路由)和EnableSwaggerUi(Swagger UI页面路由)的第一个路径参数即可,示例代码如下:
public static class SwaggerConfig { public static void Register() { GlobalConfiguration.Configuration // 第一个参数修改为你自定义的前缀 + docs/{apiVersion},这里前缀设为user .EnableSwagger("user/docs/{apiVersion}", c => { // 原有配置保持不变,比如版本、接口注释规则等 c.SingleApiVersion("v1", "你的Web API项目名称"); // 其他原有配置... }) // 第一个参数修改为你自定义的前缀 + {*assetPath},前缀和上面保持一致设为user .EnableSwaggerUi("user/{*assetPath}", c => { // 原有UI配置保持不变,比如主题、展示规则等 // 其他原有配置... }); } }
- 配置完成后重新编译启动项目,直接访问
http://localhost:<随机端口>/user即可进入Swagger UI页面,原有默认的/swagger/ui路径会自动失效。
注意:两处配置的前缀必须保持一致,否则会出现UI加载不到静态资源、接口元数据获取失败的问题。
内容的提问来源于stack exchange,提问作者Tinz
相关产品推荐
相关产品推荐

