前言

首先希望webapi支持多版本,swagger针对不同的版本可进行交互。多版本控制基于microsoft.aspnetcore.mvc.versioning.apiexplorer包,swagger可以选择swashbuckle.aspnetcore和nswag.aspnetcore.由于我们系统使用的是nswag所以继续沿用,当然swashbuckle.aspnetcore也和不错,有时间再总结。

版本控制

1.导入相关nuget。swashbuckle.aspnetcore,nswag.aspnetcore.

2.添加api多版本控制服务

2.1.首先是让项目支持多版本的服务添加

服务我们已经注入了,下面我们看一下怎么webapi多版本的支持

2.1.1.多版本的控制

1.querystring

当我们注册服务时不加 option.apiversionreader = new headerapiversionreader(“api-version”);那么版本信息就是通过url?api-version=2进行传递

2.header

如果不指定版本路由那么定义apiversionreader 则通过header传递

以上两种方式,默认版本(v1.0)均可不传递版本号

3.版本路由

这种方式很直观,但如果原有项目没有使用多版本控制不建议用,可采用header的方式更为合理一些,

2.1.2同一个 controller支持多版本

增加多个 [apiversion(“2.0”)]即可。

但是两个相同的版本中controller不能有相同的方法。比如v1文件夹和v2文件的usercontroller都指向v2版本,是不能同时拥有getlist()的,但是如果我们想要v2中的getlist重写v1的getlist方法,其他的方法都继承过来怎么处理呢?

v1版本中的controller指定[apiversion(“1.0”)][apiversion(“2.0”)]

v2版本中的controller指定[apiversion(“2.0”)]

v1版本中的getlist()方法 maptoapiversion到v1即可

这样以来v1与v2中的getlist就互不影响了。

3.注册nswag(addopenapidocument和addswaggerdocument)

nswag注入服务有两个方法:addopenapidocument和addswaggerdocument,两者的区别就是架构类型不一样,addopenapidocument的schematype使用的是openapi3,addswaggerdocument的schematype使用的是swagger2:

我用的是addswaggerdocument

4,nswag中间件

是的我们做任何配置,如果你愿意其实有很多好玩的。但上面的配置方式足够多版本的控制与nswag交互。

到此这篇关于net core webapi多版本控制与swagger(nswag)配置教程的文章就介绍到这了,更多相关net core webapi多版本控制内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!