经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » ASP.net » 查看文章
DotNetCore笔记-nginx代理访问swagger
来源:cnblogs  作者:季节旋风  时间:2021/1/4 9:49:29  对本文有异议

 

最近在学习.NetCore时,准备在linux环境上发布自己Demo项目,并使用nginx代理提供服务。环境和项目部署完后,查看swagger页面,发现无法定位到swagger.json。造成这种问题的原因是:使用代理后,前端请求的地址发生变化,而Swagger又无法自行处理。【记录下,以免忘记。^_^】

这里就需要调整项目的swagger使用代码,并在nginx的location中增加配置。

先看调整前的swagger代码:

  1. app.UseSwagger();
  2. app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "MyAPI v1"));

 

解决步骤:

1、调整nginx配置,在location下增加“proxy_set_header X-Forwarded-Prefix wdapi;”配置

  1. location / myapi / {
  2. proxy_pass http://localhost:5000/; # 被代理服务器的站点地址
  3. proxy_set_header X-Forwarded-Proto $scheme; # 将请求使用的协议告知被代理服务器
  4. proxy_set_header Host $http_host; # 将请求的地址告知被代理服务器
  5. proxy_set_header X-Forwarded-Prefix myapi; # 将路由名称"myapi"告知被代理服务器
  6. }

 

2、调整项目中调用swagger中间件的代码

  1. app.UseSwagger(c =>
  2. {
  3. c.PreSerializeFilters.Add((doc, item) =>
  4. {
  5. //根据代理服务器提供的协议、地址和路由,生成api文档服务地址
  6. doc.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"{item.Scheme}://{item.Host.Value}/{item.Headers["X-Forwarded-Prefix"]}" } };
  7. });
  8. });
  9. //使用相对路径提供
  10. 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"));

原文链接:http://www.cnblogs.com/jijiexuanfeng/p/14217292.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号