标签:Forwarded item app 代理服务器 nginx DotNetCore swagger proxy
最近在学习.NetCore时,准备在linux环境上发布自己Demo项目,并使用nginx代理提供服务。环境和项目部署完后,查看swagger页面,发现无法定位到swagger.json。造成这种问题的原因是:使用代理后,前端请求的地址发生变化,而Swagger又无法自行处理。【记录下,以免忘记。^_^】
这里就需要调整项目的swagger使用代码,并在nginx的location中增加配置。
先看调整前的swagger代码:
app.UseSwagger(); app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI v1"));
解决步骤:
1、调整nginx配置,在location下增加“proxy_set_header X-Forwarded-Prefix wdapi;”配置
location / myapi / { proxy_pass http://localhost:5000/; # 被代理服务器的站点地址 proxy_set_header X-Forwarded-Proto $scheme; # 将请求使用的协议告知被代理服务器 proxy_set_header Host $http_host; # 将请求的地址告知被代理服务器 proxy_set_header X-Forwarded-Prefix myapi; # 将路由名称"myapi"告知被代理服务器 }
2、调整项目中调用swagger中间件的代码
app.UseSwagger(c => { c.PreSerializeFilters.Add((doc, item) => { //根据代理服务器提供的协议、地址和路由,生成api文档服务地址 doc.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"{item.Scheme}://{item.Host.Value}/{item.Headers["X-Forwarded-Prefix"]}" } }; }); }); //使用相对路径提供 app.UseSwaggerUI(c => c.SwaggerEndpoint("v1/swagger.json", "MyApi v1"));
最近在学习.NetCore时,准备在linux环境上发布自己Demo项目,并使用nginx代理提供服务。环境和项目部署完后,查看swagger页面,发现无法定位到swagger.json。造成这种问题的原因是:使用代理后,前端请求的地址发生变化,而Swagger又无法自行处理。
这里就需要调整项目的swagger使用代码,并在nginx的location中增加配置。
先看调整前的swagger代码:
app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI v1"));
解决步骤:
1、调整nginx配置,在location下增加“proxy_set_header X-Forwarded-Prefix wdapi;”配置
location / myapi / {
proxy_pass http://localhost:5000/; # 被代理服务器的站点地址
proxy_set_header X-Forwarded-Proto $scheme; # 将请求使用的协议告知被代理服务器
proxy_set_header Host $http_host; # 将请求的地址告知被代理服务器
proxy_set_header X-Forwarded-Prefix myapi; # 将路由名称"myapi"告知被代理服务器}
2、调整项目中调用swagger中间件的代码
app.UseSwagger(c =>
{
c.PreSerializeFilters.Add((doc, item) =>
{
//根据代理服务器提供的协议、地址和路由,生成api文档服务地址
doc.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"{item.Scheme}://{item.Host.Value}/{item.Headers["X-Forwarded-Prefix"]}" } };
});
});
//使用相对路径提供
app.UseSwaggerUI(c => c.SwaggerEndpoint("v1/swagger.json", "MyApi v1"));
标签:Forwarded,item,app,代理服务器,nginx,DotNetCore,swagger,proxy 来源: https://www.cnblogs.com/jijiexuanfeng/p/14217292.html
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。