189 8069 5689

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

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

目前成都创新互联公司已为1000+的企业提供了网站建设、域名、网络空间、网站运营、企业网站设计、朝阳网站维护等服务,公司将坚持客户导向、应用为本的策略,正道将秉承"和谐、参与、激情"的文化,与客户和合作伙伴齐心协力一起成长,共同发展。

前言

随着前后端分离模式与微服务架构的出现,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中间件

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

4. 配置appsettings.json

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

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

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

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

测试

1. 开发环境测试

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

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

2. 模拟生产环境测试

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

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

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

准备nginx.conf,并启动nginx。

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

访问二级目录

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

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


网页标题:如何解析Swagger适配虚拟目录及二级目录
链接分享:http://cdxtjz.cn/article/jjceph.html

其他资讯