.net core小技巧 -尊龙游戏旗舰厅官网

　　随着前后端分离模式与微服务架构的出现，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/; }} }

 

访问二级目录

 

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

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

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

 

　　https://github.com/erikxu/.netcoretips/tree/master/swaggervirtualpath

转载于:https://www.cnblogs.com/erik_xu/p/9195803.html

总结

以上是尊龙游戏旗舰厅官网为你收集整理的.net core小技巧 - swagger适配虚拟目录及二级目录的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得尊龙游戏旗舰厅官网网站内容还不错，欢迎将尊龙游戏旗舰厅官网推荐给好友。