.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中间件

4. 配置appsettings.json

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

测试

1. 开发环境测试

 

 

 

2. 模拟生产环境测试

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

 

 

准备nginx.conf，并启动nginx。

访问二级目录

 

小结

　　本文涉及的代码并不多，主要想表达的是设计思路，以及对多环境的处理方案，不得不说的是，.Net Core在环境适配以及其它方面的设计都十分优秀。

　　二级目录适配虽然是个很小的问题，但是却是微服务实践中一个很常见的问题。

　　二级目录适配能否自动适配而非配置适配，也是一个值得思考的问题。　　

 

源码

　　https://github.com/ErikXu/.NetCoreTips/tree/master/SwaggerVirtualPath

原文地址：https://www.cnblogs.com/Erik_Xu/p/9195803.html

.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com