溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

如何配置swagge和控制net core webapi

發(fā)布時(shí)間：2020-11-05 15:14:32 來(lái)源：億速云 閱讀：155 作者：Leah 欄目：開(kāi)發(fā)技術(shù)

本篇文章為大家展示了如何配置swagge和控制net core webapi，內(nèi)容簡(jiǎn)明扼要并且容易理解，絕對(duì)能使你眼前一亮，通過(guò)這篇文章的詳細(xì)介紹希望你能有所收獲。

前言

首先希望webapi支持多版本，swagger針對(duì)不同的版本可進(jìn)行交互。多版本控制基于Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer包，swagger可以選擇Swashbuckle.AspNetCore和nswag.AspNetCore.由于我們系統(tǒng)使用的是nswag所以繼續(xù)沿用，當(dāng)然Swashbuckle.AspNetCore也和不錯(cuò)，有時(shí)間再總結(jié)。

版本控制

1.導(dǎo)入相關(guān)nuget。Swashbuckle.AspNetCore，nswag.AspNetCore.

2.添加api多版本控制服務(wù)

2.1.首先是讓項(xiàng)目支持多版本的服務(wù)添加

services.AddApiVersioning(option =>
  {
   // 可選，為true時(shí)API返回支持的版本信息
   option.ReportApiVersions = true;
   // 不提供版本時(shí)，默認(rèn)為1.0
   option.AssumeDefaultVersionWhenUnspecified = true;
   //版本信息放到header ,不寫(xiě)在不配置路由的情況下，版本信息放到response url 中
   option.ApiVersionReader = new HeaderApiVersionReader("api-version");
   // 請(qǐng)求中未指定版本時(shí)默認(rèn)為1.0
   option.DefaultApiVersion = new ApiVersion(1, 0);
  }).AddVersionedApiExplorer(option =>
  {  // 版本名的格式：v+版本號(hào)
   option.GroupNameFormat = "'v'V";
   option.AssumeDefaultVersionWhenUnspecified = true;
  });
  ////獲取webapi版本信息，用于swagger多版本支持 
  this.provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();

服務(wù)我們已經(jīng)注入了，下面我們看一下怎么webapi多版本的支持

2.1.1.多版本的控制

1.QueryString

/// <summary>
 /// 用戶管理API
 /// </summary>
 [ServiceFilter(typeof(LogFilterAttribute))]
 [ApiController]
 [Route("api/[controller]/[action]")]
 [ApiVersion("2.0")]
 
 public class UserController : ApiController
 {}

當(dāng)我們注冊(cè)服務(wù)時(shí)不加 option.ApiVersionReader = new HeaderApiVersionReader("api-version");那么版本信息就是通過(guò)url？api-version=2進(jìn)行傳遞

如何配置swagge和控制net core webapi

2.header

/// <summary>
 /// 用戶管理API
 /// </summary>
 [ServiceFilter(typeof(LogFilterAttribute))]
 [ApiController]
 [Route("api/[controller]/[action]")]
 [ApiVersion("2.0")]
 
 public class UserController : ApiController
 {}

如果不指定版本路由那么定義ApiVersionReader 則通過(guò)header傳遞

如何配置swagge和控制net core webapi

以上兩種方式，默認(rèn)版本（v1.0）均可不傳遞版本號(hào)

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
 {}

如何配置swagge和控制net core webapi

這種方式很直觀，但如果原有項(xiàng)目沒(méi)有使用多版本控制不建議用，可采用header的方式更為合理一些，

2.1.2同一個(gè) Controller支持多版本

增加多個(gè) [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
 {}

但是兩個(gè)相同的版本中Controller不能有相同的方法。比如v1文件夾和v2文件的UserController都指向v2版本,是不能同時(shí)擁有GetList()的，但是如果我們想要v2中的GetList重寫(xiě)v1的GetList方法，其他的方法都繼承過(guò)來(lái)怎么處理呢？

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()
 {}

這樣以來(lái)v1與v2中的GetList就互不影響了。

3.注冊(cè)nswag（AddOpenApiDocument和AddSwaggerDocument）

NSwag注入服務(wù)有兩個(gè)方法：AddOpenApiDocument和AddSwaggerDocument，兩者的區(qū)別就是架構(gòu)類型不一樣，AddOpenApiDocument的SchemaType使用的是OpenApi3，AddSwaggerDocument的SchemaType使用的是Swagger2：

如何配置swagge和控制net core webapi

我用的是AddSwaggerDocument

foreach (var description in provider.ApiVersionDescriptions)
  {
   services.AddSwaggerDocument(document =>
  {
   document.OperationProcessors.Add(new OperationSecurityScopeProcessor("JWT token"));
   document.DocumentName = description.GroupName;
   document.Version = description.GroupName;
   document.ApiGroupNames = new string[] { description.GroupName };
   //jwt 認(rèn)證
   document.AddSecurity("JWT token", Enumerable.Empty<string>(),
    new OpenApiSecurityScheme()
    {
    Type = OpenApiSecuritySchemeType.ApiKey,
    Name = nameof(Authorization),
    In = OpenApiSecurityApiKeyLocation.Header,
    Description = "將token值復(fù)制到如下格式: \nBearer {token}"
    }
   );

  });
  }

4,nswag中間件

app.UseOpenApi();
  app.UseSwaggerUi3(setting =>
  {
  });

是的我們做任何配置，如果你愿意其實(shí)有很多好玩的。但上面的配置方式足夠多版本的控制與nswag交互。

如何配置swagge和控制net core webapi

上述內(nèi)容就是如何配置swagge和控制net core webapi，你們學(xué)到知識(shí)或技能了嗎？如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備，歡迎關(guān)注億速云行業(yè)資訊頻道。

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手