zoukankan      html  css  js  c++  java
  • .NET Core:Api版本控制

    (1)先安装Microsoft.AspNetCore.Mvc.Versioning
    (2)在Startup的ConfigureServices方法中加入:
    services.AddApiVersioning(o => {
      o.ReportApiVersions = true;
      o.AssumeDefaultVersionWhenUnspecified = true;
      o.DefaultApiVersion = new ApiVersion(1, 0);
    });

      ReportApiVersion属性是一个布尔类型,如果设置为true, 在Api请求的响应头部,会追加当前Api支持的版本。
      AssumeDefaultVersionWhenUnspecified属性是为了标记当客户端没有指定版本号的时候,是否使用默认版本号。
      DefaultApiVersion属性即默认版本号。
    (3)使用路由约束进行版本控制
      在控制器中加入:
    [ApiVersion("1.0")]
    [Route("api/{v:apiVersion}/[controller]/[action]")]
    [ApiController]
    [EnableCors("any")]
    public class ValuesController : ControllerBase{}

    (4)使用查询字符串(Query String)进行版本控制
      开发人员可以在Url中指定api-version参数来选择调用的Api版本号。
      例如https://localhost:44319/api/values?api-version=2.0
    (5)使用请求头(HTTP Header)进行版本控制
      在HTTP请求头中添加版本号参数。为了启用这种方式,我们首先需要在Startup.cs中修改Microsoft.AspNetCore.Mvc.Versioning的配置, 代码如下:
    services.AddApiVersioning(o => {
      o.ReportApiVersions = true;
      o.AssumeDefaultVersionWhenUnspecified = true;
      o.DefaultApiVersion = new ApiVersion(1, 0);
      o.ApiVersionReader = new HeaderApiVersionReader("m-api-version");
    });

      这里通过ApiVersionReader属性指定了Api版本号是从请求头部的x-api-version属性来的。
      一旦你使用o.ApiVersionReader = new HeaderApiVersionReader("x-api-version");, 在查询字符串中指定版本号的方式将不再可用。
      如果你希望同时支持2种方式,请改用:
    o.ApiVersionReader = ApiVersionReader.Combine(new QueryStringApiVersionReader(), new HeaderApiVersionReader() { HeaderNames = { "x-api-version" }});

    (6)其他特性
      有些时候,我们需要标记一些过时的Api为弃用状态,但是我们又不希望完全移除这个版本的Api, 我们可以使用Deprecated特性。[ApiVersion("1.0", Deprecated = true)]
      使用ApiVersionNeutral指定不需要版本控制的Api,将它从Api版本控制中排除掉。[ApiVersionNeutral]

  • 相关阅读:
    又是一年毕业季——程序员的苦与乐
    你的团队需要一个正确的程序集(dll)管理姿势
    说一说Web开发中两种常用的分层架构及其对应的代码模型
    理解RESTful API
    一文回顾Redis五大对象(数据类型)
    Redis对象——有序集合(ZSet)
    Redis对象——集合(Set)
    Redis对象——列表(List)
    Redis对象——哈希(Hash)
    Redis数据结构——quicklist
  • 原文地址:https://www.cnblogs.com/liusuqi/p/11883292.html
Copyright © 2011-2022 走看看