最近在學習.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"));
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/243079.html
標籤：.NET技术