如何在ASP.NET中利用WebApi實(shí)現(xiàn)一個(gè)版本控制功能-創(chuàng)新互聯(lián)

本篇文章為大家展示了如何在ASP.NET中利用WebApi實(shí)現(xiàn)一個(gè)版本控制功能，內(nèi)容簡(jiǎn)明扼要并且容易理解，絕對(duì)能使你眼前一亮，通過這篇文章的詳細(xì)介紹希望你能有所收獲。

創(chuàng)新互聯(lián)建站于2013年開始，是專業(yè)互聯(lián)網(wǎng)技術(shù)服務(wù)公司，擁有項(xiàng)目成都網(wǎng)站制作、成都網(wǎng)站設(shè)計(jì)網(wǎng)站策劃，項(xiàng)目實(shí)施與項(xiàng)目整合能力。我們以讓每一個(gè)夢(mèng)想脫穎而出為使命，1280元梁平做網(wǎng)站,已為上家服務(wù),為梁平各地企業(yè)和個(gè)人服務(wù),聯(lián)系電話:18982081108

WebApi版本控制的好處

有助于及時(shí)推出功能, 而不會(huì)破壞現(xiàn)有系統(tǒng)，兼容性處理更友好。
它還可以幫助為選定的客戶提供額外的功能。

接下來就來實(shí)現(xiàn)版本控制以及在Swagger UI中接入WebApi版本

一、WebApi版本控制實(shí)現(xiàn)　

通過Microsoft.AspNetCore.Mvc.Versioning實(shí)現(xiàn)webapi 版本控制

創(chuàng)建WebApi項(xiàng)目，添加Nuget包：Microsoft.AspNetCore.Mvc.Versioning

Install-Package Microsoft.AspNetCore.Mvc.Versioning

修改項(xiàng)目Startup文件，使用Microsoft.AspNetCore.Mvc.Versioning

public class Startup
{
  public Startup(IConfiguration configuration)
  {
    Configuration = configuration;
  }
  public IConfiguration Configuration { get; }

  // This method gets called by the runtime. Use this method to add services to the container.
  public void ConfigureServices(IServiceCollection services)
  {
    //根據(jù)需要設(shè)置，以下內(nèi)容
    services.AddApiVersioning(apiOtions =>
    {
      //返回響應(yīng)標(biāo)頭中支持的版本信息
      apiOtions.ReportApiVersions = true;
      //此選項(xiàng)將用于不提供版本的請(qǐng)求。默認(rèn)情況下, 假定的 API 版本為1.0
      apiOtions.AssumeDefaultVersionWhenUnspecified = true;
      //缺省api版本號(hào)，支持時(shí)間或數(shù)字版本號(hào)
      apiOtions.DefaultApiVersion = new ApiVersion(1, 0);
      //支持MediaType、Header、QueryString 設(shè)置版本號(hào);缺省為QueryString、UrlSegment設(shè)置版本號(hào);后面會(huì)詳細(xì)說明對(duì)于作用
      apiOtions.ApiVersionReader = ApiVersionReader.Combine(
        new MediaTypeApiVersionReader("api-version"),
        new HeaderApiVersionReader("api-version"),
        new QueryStringApiVersionReader("api-version"),
        new UrlSegmentApiVersionReader());
    });
    services.AddControllers();
  }

  // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
  public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
  {
    if (env.IsDevelopment())
    {
      app.UseDeveloperExceptionPage();
    }
    app.UseHttpsRedirection();

    //使用ApiVersioning
    app.UseApiVersioning();
    app.UseRouting();
    app.UseAuthorization();
    app.UseEndpoints(endpoints =>
    {
      endpoints.MapControllers();
    });
  }
}

WebApi設(shè)置版本：

a）通過ApiVersion標(biāo)記指定指定控制器或方法的版本號(hào)；Url參數(shù)控制版本(QueryStringApiVersionReader)，如下：

namespace WebAPIVersionDemo.Controllers
{
  [ApiController]
  [Route("[controller]")]
  //Deprecated=true:表示v1即將棄用，響應(yīng)頭中返回
  [ApiVersion("1.0", Deprecated = true)]
  [ApiVersion("2.0")]public class WeatherForecastController : ControllerBase
  {
    private static readonly string[] Summaries = new[]{"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"};
 
    [HttpGet]
    public IEnumerable Get()
    {
      var rng = new Random();
      return Enumerable.Range(1, 5).Select(index => new WeatherForecast
      {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = rng.Next(-20, 55),
        Summary = $"v1:{Summaries[rng.Next(Summaries.Length)]}"
      })
      .ToArray();
    }    
  }
}

通過參數(shù)api-version參數(shù)指定版本號(hào)；調(diào)用結(jié)果：