|
副问题[/!--empirenews.page--]
起首但愿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.起首是让项目支持多版本的处事添加
services.AddApiVersioning(option =>
{
// 可选，为true时API返回支持的版本信息
option.ReportApiVersions = true;
// 不提供版本时，默以为1.0
option.AssumeDefaultVersionWhenUnspecified = true;
//版本信息放到header ,不写在不设置路由的环境下，版本信息放到response url 中
option.ApiVersionReader = new HeaderApiVersionReader("api-version");
// 哀求中未指定版本时默以为1.0
option.DefaultApiVersion = new ApiVersion(1, 0);
}).AddVersionedApiExplorer(option =>
{ // 版本名的名目：v+版本号
option.GroupNameFormat = "'v'V";
option.AssumeDefaultVersionWhenUnspecified = true;
});
////获取webapi版本信息，用于swagger多版本支持
this.provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();
处事我们已经注入了，下面我们看一下怎么webapi多版本的支持
2.1.1.多版本的节制
1.QueryString
/// <summary>
/// 用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/[controller]/[action]")]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
当我们注册处事时不加 option.ApiVersionReader = new HeaderApiVersionReader("api-version");那么版本信息就是通过url？api-version=2举办转达2.header
2.header
/// <summary>
/// 用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/[controller]/[action]")]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
假如不指定版本路由那么界说ApiVersionReader 则通过header转达
以上两种方法，默认版本（v1.0）均可不转达版本号
3.版本路由
/// <summary>
/// 用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/v{version:apiVersion}/[controller]/[action]")]
[Authorize]
[ApiVersion("1.0")]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
这种方法很直观，但假如原有项目没有行使多版本节制不提议用，可回收header的方法更为公道一些，
2.1.2统一个 Controller支持多版本
增进多个 [ApiVersion("2.0")]即可。
/// <summary>
/// 用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/v{version:apiVersion}/[controller]/[action]")]
//[Authorize]
[ApiVersion("1.0")]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
可是两个沟通的版本中Controller不能有沟通的要领。好比v1文件夹和v2文件的UserController都指向v2版本,是不能同时拥有GetList()的，可是假如我们想要v2中的GetList重写v1的GetList要领，其他的要领都担任过来怎么处理赏罚呢？
v1版本中的controller指定[ApiVersion("1.0")][ApiVersion("2.0")]
/// <summary>
/// v1.用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/v{version:apiVersion}/[controller]/[action]")]
//[Authorize]
[ApiVersion("1.0")]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
v2版本中的controller指定[ApiVersion("2.0")]
/// <summary>
/// v1.用户打点API
/// </summary>
[ServiceFilter(typeof(LogFilterAttribute))]
[ApiController]
[Route("api/v{version:apiVersion}/[controller]/[action]")]
//[Authorize]
[ApiVersion("2.0")]
public class UserController : ApiController
{}
v1版本中的GetList（）要领 MapToApiVersion到v1即可
/// <summary>
/// 获取用户列表
/// </summary>
/// <returns></returns>
[HttpGet,MapToApiVersion("1.0")]
public NetResponse<List<User>> GetList()
{}
这样以来v1与v2中的GetList就互不影响了。
3.注册nswag（AddOpenApiDocument和AddSwaggerDocument）
NSwag注入处事有两个要领：AddOpenApiDocument和AddSwaggerDocument，两者的区别就是架构范例纷歧样，AddOpenApiDocument的SchemaType行使的是OpenApi3，AddSwaggerDocument的SchemaType行使的是Swagger2：
我用的是AddSwaggerDocument
（编辑：湖南网）
【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!
|
