千家信息网

如何解析Swagger适配虚拟目录及二级目录

发表于:2024-09-22 作者:千家信息网编辑
千家信息网最后更新 2024年09月22日,小编今天带大家了解如何解析Swagger适配虚拟目录及二级目录,文中知识点介绍的非常详细。觉得有帮助的朋友可以跟着小编一起浏览文章的内容,希望能够帮助更多想解决这个问题的朋友找到问题的答案,下面跟着小
千家信息网最后更新 2024年09月22日如何解析Swagger适配虚拟目录及二级目录

小编今天带大家了解如何解析Swagger适配虚拟目录及二级目录,文中知识点介绍的非常详细。觉得有帮助的朋友可以跟着小编一起浏览文章的内容,希望能够帮助更多想解决这个问题的朋友找到问题的答案,下面跟着小编一起深入学习"如何解析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的配置:

在appsettings。Development.json中添加virrualpath的配置:

测试

1. 开发环境测试

2. 模拟生产环境测试

修改launchSettings.json,改变环境变量参数:

准备nginx.conf,并启动nginx。

访问二级目录

感谢大家的阅读,以上就是"如何解析Swagger适配虚拟目录及二级目录"的全部内容了,学会的朋友赶紧操作起来吧。相信小编一定会给大家带来更优质的文章。谢谢大家对网站的支持!

0