解決 asp.net core swagger nginx 代理服務器轉發后，無法訪問的問題 Swashbuckle

本文轉載自查看原文 2020-04-29 11:55 1211

通過代理轉發后，webapi的swagger無法訪問，本質原因是代理后url路徑發生變化導致swagger無法定位到json。

官方文檔配置：
https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle
https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-nginx?view=aspnetcore-3.1#use-a-reverse-proxy-server

c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");

解決方法：

使用url相對路徑
通過PreSerializeFilters設置根地址，並通過nginx的X-Forwarded-Prefix指定api名稱

nginx配置：

server {
        listen       5011;
        server_name  _;

        location /api1/ {
            proxy_pass         http://192.168.56.1:5000/;
            proxy_http_version 1.1;
            proxy_set_header   Upgrade $http_upgrade;
            proxy_set_header   Connection keep-alive;
            proxy_set_header   Host $http_host; # 使用http_host而非host以滿足帶有端口號的情況
            proxy_cache_bypass $http_upgrade;
            proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header   X-Forwarded-Proto $scheme;
	    proxy_set_header   X-Forwarded-Prefix api1; # api1用於傳遞路由名稱
        }
    }

Swashbuckle 5.x 以前通過PreSerializeFilters設置BasePath的方案，5.x以后，設置OpenApiServer.Url屬性

代碼如下：

app.UseSwagger(c =>
{
	c.PreSerializeFilters.Add((swagger, httpReq) =>
	{
                //根據訪問地址，設置swagger服務路徑
		swagger.Servers = new List<OpenApiServer> { new OpenApiServer { Url = $"{httpReq.Scheme}://{httpReq.Host.Value}/{httpReq.Headers["X-Forwarded-Prefix"]}" } };
	});
});

app.UseSwaggerUI(c =>
{
        //使用相對路徑
	c.SwaggerEndpoint("v1/swagger.json", "My API V1");
});

github demo： https://github.com/wswind/swagger-proxy

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 ASP.NET Core 實現帶認證功能的Web代理服務器 2019.9.8為什么一些外國網站我們無法訪問，但是使用代理服務器可以在ubuntu中，通過代理服務器訪問網絡 Maven啟用代理服務器訪問配置Nginx作為反向代理服務器在Centos7中創建.net core 項目，並用Apache做代理服務器部署.net core項目 wireshark 代理服務器如何搭建代理服務器 Jmeter使用http代理服務器錄制頁面遇到的問題&解決辦法解決服務器部署Nginx后不能訪問Swagger