Asp.Net Core Swagger页面适配Nginx二级目录

前言

当我们把 Asp.Net Core 程序部署在 Nginx 后面时,通常来说,不会使用顶级目录,而是使用二级目录,访问方式类似:

http://{DOMAIN}/{BASEPATH}/WeatherForecast

Ngix 配置

假设 Nginx 开放端口8000,二级目录设为 demo,Asp.Net Core 程序实际访问地址为 http://localhost:5000/.

则 Ngix 配置如下:

server {
    listen       8000;
    server_name  localhost;

    location /demo/ {
        proxy_pass   http://localhost:5000/;
    }
}

可以看到可以正常访问API:

Asp.Net Core Swagger页面适配Nginx二级目录

但是,打开swagger页面时,会提示找不到/swagger/v1/swagger.json

Asp.Net Core Swagger页面适配Nginx二级目录

常规方案

百度了一下,找到了所谓的“完美解决方案”:

Asp.Net Core Swagger页面适配Nginx二级目录

他是使用app.UsePathBase方法,设置站点请求基础路径,也就是说 Asp.Net Core 程序实际访问地址也是带二级目录的:

Asp.Net Core Swagger页面适配Nginx二级目录

这种方案当然可以实现需求,但是远远谈不上“完美”——如果修改 Nginx 二级目录设置,还要同步修改 Asp.Net Core 配置,而且还要保证二者名称完全相同。

我的方案

1.解决相对路径问题

首先,我们分析,为什么找不到/swagger/v1/swagger.json文件。

其实,这是因为如果 url 以“/”开头,浏览器会从请求的根目录开始查找,从错误提示也可以看出:

Asp.Net Core Swagger页面适配Nginx二级目录

我们可以去掉“/”,让浏览器从发起请求的路径开始查找。

通过 Referer 请求头,我们可以知道发起请求的路径是/demo/swagger/

Asp.Net Core Swagger页面适配Nginx二级目录

因此,我们只需要修改成如下相对路径即可:

app.UseSwaggerUI(c => c.SwaggerEndpoint("v1/swagger.json", "WebApplication1 v1"));

Asp.Net Core Swagger页面适配Nginx二级目录

2.解决服务根地址问题

上面解决了 swagger.json 访问问题,但是在 swagger 中测试 API 时,会提示 404:

Asp.Net Core Swagger页面适配Nginx二级目录

这是因为 swagger 并不知道 API 路径需要增加二级目录。

如果采用“完美解决方案”中的方式,使用配置指定二级目录,那又回到老路上去了:

Asp.Net Core Swagger页面适配Nginx二级目录

其实,Nginx 转发请求时,是知道原始请求地址的,我们只需要将原始请求地址告诉 swagger。

首先,修改 Ngix 配置:

location /demo/ {
    proxy_pass   http://localhost:5000/;
    proxy_set_header X-Request-Uri $request_uri;
}

然后,由 swagger 来分析出二级目录即可,不需要增加任何配置:

app.UseSwagger(options =>
{
    options.PreSerializeFilters.Add((swagger, httpReq) =>
    {
        if (httpReq.Headers.ContainsKey("X-Request-Uri"))
        {
            var index = httpReq.Headers["X-Request-Uri"].ToString().IndexOf("/swagger/");
            if (index > 0)
            {
                var serverUrl = $"{httpReq.Headers["X-Request-Uri"].ToString().Substring(0, index)}/";
                swagger.Servers = new List<OpenApiServer> { new OpenApiServer { Url = serverUrl } };
            }
        }
    });
});

Asp.Net Core Swagger页面适配Nginx二级目录

结论

我们的实现方案,相对网上找到的“完美解决方案”,需要配置的地方更少,而且更加灵活,对开发环境不会产生任何影响和变动。

深圳SEO优化公司河池网站优化排名多少钱大丰seo排名丹竹头设计公司网站多少钱南宁建网站推荐楚雄SEO按天收费推荐朝阳企业网站设计公司雅安企业网站设计推荐凉山seo网站优化价格三明品牌网站设计哪家好台州企业网站建设价格聊城网站设计多少钱株洲网站制作推荐襄樊网络营销多少钱唐山企业网站改版公司海西网站推广价格淄博百度竞价包年推广报价临沧网站排名优化报价乌海百度爱采购价格庆阳推广网站哪家好大连SEO按天计费推荐盐田网站关键词优化价格防城港品牌网站设计推荐伊春高端网站设计哪家好西宁网络推广公司抚州建站多少钱苏州seo优化推荐海西网站推广抚州百度关键词包年推广推荐蚌埠关键词按天收费价格广东外贸网站设计公司歼20紧急升空逼退外机英媒称团队夜以继日筹划王妃复出草木蔓发 春山在望成都发生巨响 当地回应60岁老人炒菠菜未焯水致肾病恶化男子涉嫌走私被判11年却一天牢没坐劳斯莱斯右转逼停直行车网传落水者说“没让你救”系谣言广东通报13岁男孩性侵女童不予立案贵州小伙回应在美国卖三蹦子火了淀粉肠小王子日销售额涨超10倍有个姐真把千机伞做出来了近3万元金手镯仅含足金十克呼北高速交通事故已致14人死亡杨洋拄拐现身医院国产伟哥去年销售近13亿男子给前妻转账 现任妻子起诉要回新基金只募集到26元还是员工自购男孩疑遭霸凌 家长讨说法被踢出群充个话费竟沦为间接洗钱工具新的一天从800个哈欠开始单亲妈妈陷入热恋 14岁儿子报警#春分立蛋大挑战#中国投资客涌入日本东京买房两大学生合买彩票中奖一人不认账新加坡主帅:唯一目标击败中国队月嫂回应掌掴婴儿是在赶虫子19岁小伙救下5人后溺亡 多方发声清明节放假3天调休1天张家界的山上“长”满了韩国人?开封王婆为何火了主播靠辱骂母亲走红被批捕封号代拍被何赛飞拿着魔杖追着打阿根廷将发行1万与2万面值的纸币库克现身上海为江西彩礼“减负”的“试婚人”因自嘲式简历走红的教授更新简介殡仪馆花卉高于市场价3倍还重复用网友称在豆瓣酱里吃出老鼠头315晚会后胖东来又人满为患了网友建议重庆地铁不准乘客携带菜筐特朗普谈“凯特王妃P图照”罗斯否认插足凯特王妃婚姻青海通报栏杆断裂小学生跌落住进ICU恒大被罚41.75亿到底怎么缴湖南一县政协主席疑涉刑案被控制茶百道就改标签日期致歉王树国3次鞠躬告别西交大师生张立群任西安交通大学校长杨倩无缘巴黎奥运

深圳SEO优化公司 XML地图 TXT地图 虚拟主机 SEO 网站制作 网站优化