.Net Core小技巧 - Swagger适配虚拟目录及二级目录

Posted 2020-11-19 erik_xu

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了.Net Core小技巧 - Swagger适配虚拟目录及二级目录相关的知识，希望对你有一定的参考价值。

前言

　　随着前后端分离模式与微服务架构的出现，Web API变得越来越重要及普遍。而后出现的网关技术，使开发者更倾向于使用二级/多级目录来暴露Web API，一是暴露的端口更少，方便管理；二是在网关中可以处理一些公共的事务，如认证。但swagger默认是适配根（root）目录的，想要适配二级/多级目录，需要额外处理，同时还要区分开发环境与其它环境。一种思路是在开发环境就让Web API是处于二级目录，此时可以在本机通过nginx和iis虚拟目录来模拟，但这种思路明显略微麻烦。另一种思路是通过配置多环境的方式实现。

步骤

1. 安装Swagger

Install-Package Swashbuckle.AspNetCore

2. 配置Swagger服务

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});

3. 配置swagger中间件

var virtualPath = Configuration["virtualPath"];

app.UseSwagger(c =>
{
    c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.BasePath = virtualPath);
});

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint(virtualPath + "/swagger/v1/swagger.json", "My API V1");
    c.RoutePrefix = string.Empty;
});

4. 配置appsettings.json

在appsettings.json中添加virtualPath的配置：

{
  "virtualPath": "/sg", //假设二级目录或虚拟目录是/sg
  "Logging": {
    "IncludeScopes": false,
    "Debug": {
      "LogLevel": {
        "Default": "Warning"
      }
    },
    "Console": {
      "LogLevel": {
        "Default": "Warning"
      }
    }
  }
}

在appsettings.Development.json中添加virtualPath的配置：

{
  "virtualPath": "", //使用根目录
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
}

测试

1. 开发环境测试

技术分享图片

2. 模拟生产环境测试

修改launchSettings.json，改变环境变量参数：

技术分享图片

准备nginx.conf，并启动nginx。

worker_processes  1;

events {
    worker_connections  1024;
}

http {
    include       mime.types;
    default_type  application/octet-stream;
    sendfile        on;
    keepalive_timeout  65;

    server {
        listen       80;
        server_name  localhost;

        location /sg/ {
            proxy_pass http://localhost:30925/;  
            
        }
    }
}

访问二级目录

技术分享图片