DotNetCore笔记-nginx代理访问swagger
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了DotNetCore笔记-nginx代理访问swagger,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含2487字,纯文字阅读大概需要4分钟。
内容图文
![DotNetCore笔记-nginx代理访问swagger](/upload/InfoBanner/zyjiaocheng/932/19cb25de798c4e819c50811d37851a18.jpg)
最近在学习.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"));
内容总结
以上是互联网集市为您收集整理的DotNetCore笔记-nginx代理访问swagger全部内容,希望文章能够帮你解决DotNetCore笔记-nginx代理访问swagger所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。