.Net介面版本管理與OpenApi

董瑞鹏發表於2024-03-14
API

前言

作為開發人員，我們經常向應用程式新增新功能並修改當前的 Api。版本控制使我們能夠安全地新增新功能而不會造成中斷性變更。一個良好的 Api 版本控制策略可以清晰地傳達所做的更改，並允許使用現有 REST Api 的客戶端在準備好時才遷移或更新他們的應用程式到最新版本。

哪些行為可能會造成 Api 的中斷性變更呢？

  • 刪除或重新命名 Api
  • 修改 Api 引數(型別,名稱,可選引數變成非可選引數，刪除必需引數等)
  • 更改現有 Api 的行為
  • 更改 Api 響應
  • 更改 Api 錯誤程式碼
  • More

我們在做開發的過程中遲早會面對 Api 版本控制需求，在 Api 開發的過程中學習如何進行版本控制是至關重要的。

本文主要介紹在 MinimalApis 進行版本控制，官網文件在文末

藉助aspnet-api-versioning 幫助 Minimalapis 實現版本控制

開始之前在專案中安裝兩個 nuget 包:

Install-Package Asp.Versioning.Http
Install-Package Asp.Versioning.Mvc.ApiExplorer
  • Asp.Versioning.Http 用於在 MinimalApis 中提供版本控制支援
  • Asp.Versioning.Mvc.ApiExplorer 用於 OpenApi,格式化路由版本引數等

配置詳情

builder.Services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(2, 0);//預設版本
    options.ReportApiVersions = true;//Response Header 指定可用版本
    options.AssumeDefaultVersionWhenUnspecified = true;//如果沒有指定版本用預設配置
    options.ApiVersionReader = ApiVersionReader.Combine(
      new QueryStringApiVersionReader("api-version"),//QueryString
      new HeaderApiVersionReader("X-Version"),//Header
      new MediaTypeApiVersionReader("ver"),//Accept MediaType
      new UrlSegmentApiVersionReader());//Route Path
}).AddApiExplorer(options =>
{
    options.GroupNameFormat = "'v'VVV";
    options.SubstituteApiVersionInUrl = true;
});

AddApiVersioning 提供了一個委託引數 Action<ApiVersioningOptions>來對 Api 版本控制配置，下面看主要引數的配置解釋

  • DefaultApiVersion

    options.DefaultApiVersion = new ApiVersion(2,0);

    指定 Api 的預設版本以上設定為 2.0 版本，預設是 1.0

  • ReportApiVersions

     options.ReportApiVersions = true;//Response Header 指定可用版本

    在 ResponseHeader 中指定當前 Api 可用的版本 預設不開啟

  • AssumeDefaultVersionWhenUnspecified

    options.AssumeDefaultVersionWhenUnspecified = true;

    開啟後 如果 Api 不指定版本預設 DefaultApiVersion 設定版本，適合已經存在的服務開啟版本控制，幫助在不破壞現有客戶端的情況下改進現有服務並整合正式的 Api 。

  • ApiVersionReader

    
    options.ApiVersionReader = ApiVersionReader.Combine(
    new QueryStringApiVersionReader("api-version"),//QueryString 預設引數 api-vesion
    new HeaderApiVersionReader("X-Version"),//Header 預設v
    new MediaTypeApiVersionReader("ver"),//Accept MediaType 預設引數v
    new UrlSegmentApiVersionReader());//Route Path 引數v

    配置如何讀取客戶端指定的 Api 版本,預設為 QueryStringApiVersionReader 即使用名為 api-version 的查詢字串引數。
    從上面可以看出有四種開箱即用的 Api 服務版本定義方式

    • QueryStringApiVersionReader: https://localhost:7196/api/Todo?api-version=1
    • HeaderApiVersionReader: https://localhost:7196/api/Todo -H 'X-Version: 1'
    • MediaTypeApiVersionReader:
      GET api/helloworld HTTP/2
Host: localhost
Accept: application/json;ver=1.0
    • UrlSegmentApiVersionReader: https://localhost:7196/api/workouts?api-version=1

    可以透過ApiVersionReader.Combine聯合使用。

雖然aspnet-api-versioning提供了多種版本控制的方式，但是在我們實際專案開發的過程中，我們儘可能只採用一種方案，只用一種標準可以讓我們版本開發更加的容易維護，而且多種方案配置預設策略 對 OpenApi 的整合和版本控制的預設行為都互有影響。

以上四種方案只有QueryStringApiVersionReader和UrlSegmentApiVersionReader符合 Microsoft REST Guidelines 的規範，所以我們只需要上面選一個即可.

MinimalApis 版本控制

我們採用其中的一種 來做演示看看 ApiVesioning 是如何實現的，就按預設行為 QueryStringApiVersionReader 來做一個簡單的 Demo。

建立一個 MinimalApi 的專案

VS 建立新專案->輸入專案名字然後點選下一步-> 使用控制器的 CheckBox 確定取消勾選
.Net Cli 安裝 nuget 或者 VS 包管理器

dotnet add package Asp.Versioning.Http
dotnet add package Asp.Versioning.Mvc.ApiExplorer

Program.cs 新增預設配置

builder.Services.AddProblemDetails();
builder.Services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(2, 0);//預設版本
    options.ReportApiVersions = true;//Response Header 指定可用版本
    options.AssumeDefaultVersionWhenUnspecified = true;//如果沒有指定版本用預設配置
}).AddApiExplorer(options =>
{
    options.GroupNameFormat = "'v'VVV";
    options.SubstituteApiVersionInUrl = true;
});

aspnet-api-versioning的異常處理機制依賴ProblemDetails,
所以builder.Services.AddProblemDetails();必須要註冊到 IOC 容器。
AddApiVersioning 沒有註冊任何的ApiVersionReader，所以會用預設的QueryStringApiVersionReader的模式。

AddApiExplorer 是 OpenApi 對介面格式化的策略配置

認識 幾個核心方法

  • NewVersionedApi ：建立一個路由組建造者，用於定義 Api 中所有版本化端點。

  • HasApiVersion ：表示 ApiVersionSet 支援指定的 ApiVersion。

  • HasDeprecatedApiVersion ：配置廢棄指定的 Api 版本。

  • MapToApiVersion : 將指定的 Api 版本對映到配置的端點。

  • IsApiVersionNeutral : 版本無關 也可以說任何的版本都可以訪問到這個終結點

新增 Api EndPoint


{
    var todoV1 = app.NewVersionedApi("Todo")
         .HasDeprecatedApiVersion(new ApiVersion(1, 0));//過期版本
    var todoGroup = todoV1.MapGroup("/api/Todo");
    todoGroup.MapGet("/", () => "Version 1.0").WithSummary("請用V2版本代替");
    todoGroup.MapGet("sayhello", (string name) => $"hello {name}").
}
{
    var todoV2 = app.NewVersionedApi("Todo")
                         .HasApiVersion(new ApiVersion(2, 0));
    var todoGroup = todoV2.MapGroup("/api/Todo");
    todoGroup.MapGet("/", () => "Version 2.0").MapToApiVersion(new ApiVersion(2, 0)).WithSummary("Version2");
}
{
    var todoV3 = app.NewVersionedApi("Todo")
            .HasApiVersion(new ApiVersion(3, 0));
    var todoGroup = todoV3.MapGroup("/api/Todo");
    todoGroup.MapGet("/", () => "Version 3.0").WithSummary("Version3");
    todoGroup.MapGet("sayhello", (string name) => $"hello {name}").IsApiVersionNeutral();
}

上面定義 Todo 的相關業務，當前有三個版本，V1 已經過期不推薦使用，V2 是主要版本，V3 是預覽開發版本，IsApiVersionNeutral標註了一個sayHello介面是跟版本無關的

Run 專案 測試一下

訪問 api/Todo,Options 配置了預設版本為 2.0
https://localhost:7141/api/todo 返回 Version 2.0 符合預期
image

測試 V1 版本
https://localhost:7141/api/todo?api-version=1.0
返回 Version 1.0 符合預期且 ResponseHeader 標記了過期版本和受支援的版本
image

image

測試 V2 版本
https://localhost:7141/api/todo?api-version=2.0
可以看到 返回 Version 2.0 符合預期
image

測試 V3 版本
https://localhost:7141/api/todo?api-version=3.0
可以看到 返回 Version 3.0 符合預期
image

測試 sayHello (版本無關)

  • https://localhost:7141/api/Todo/sayhello
  • https://localhost:7141/api/Todo/sayhello?name=ruipeng& api-vesion=1.0
  • https://localhost:7141/api/Todo/sayhello?name=ruipeng&api-vesion=2.0
  • https://localhost:7141/api/Todo/sayhello?name=ruipeng&api-vesion=3.0
    image

到這兒基本可以實現我們的需求了，在aspnet-api-versioning中還提供了NewApiVersionSet的方法配置新增實現 Api 的管理，大家也可以嘗試下。

版本管理對接 OpenApi

剛才我們的專案 Run 起來之後 Swagger 首頁看到只有 V1 版本的介面,我們來設定一下讓他支援 Swagger 介面版本切換

建立 ConfigureSwaggerOptions 新增多個 SwaggerDoc

public class ConfigureSwaggerOptions(IApiVersionDescriptionProvider provider) : IConfigureOptions<SwaggerGenOptions>
{
    public void Configure(SwaggerGenOptions options)
    {
        foreach (var description in provider.ApiVersionDescriptions)
        {
            options.SwaggerDoc(description.GroupName, CreateInfoForApiVersion(description));
        }
    }

    private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
    {
        var text = new StringBuilder("An example application with OpenAPI, Swashbuckle, and API versioning.");
        var info = new OpenApiInfo()
        {
            Title = "MinimalApis With OpenApi ",
            Version = description.ApiVersion.ToString(),
            Contact = new OpenApiContact() { Name = "Ruipeng", Email = "478083649@qq.com" },
            License = new OpenApiLicense() { Name = "MIT", Url = new Uri("https://opensource.org/licenses/MIT") }
        };

        if (description.IsDeprecated)
        {
            text.Append(" This API version has been deprecated.");
        }

        if (description.SunsetPolicy is SunsetPolicy policy)
        {
            if (policy.Date is DateTimeOffset when)
            {
                text.Append(" The API will be sunset on ")
                    .Append(when.Date.ToShortDateString())
                    .Append('.');
            }

            if (policy.HasLinks)
            {
                text.AppendLine();

                for (var i = 0; i < policy.Links.Count; i++)
                {
                    var link = policy.Links[i];

                    if (link.Type == "text/html")
                    {
                        text.AppendLine();

                        if (link.Title.HasValue)
                        {
                            text.Append(link.Title.Value).Append(": ");
                        }

                        text.Append(link.LinkTarget.OriginalString);
                    }
                }
            }
        }

        info.Description = text.ToString();

        return info;
    }
}

依賴注入

builder.Services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();

建立攔截器

public class SwaggerDefaultValues : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        var apiDescription = context.ApiDescription;

        operation.Deprecated |= apiDescription.IsDeprecated();

        foreach (var responseType in context.ApiDescription.SupportedResponseTypes)
        {
            var responseKey = responseType.IsDefaultResponse ? "default" : responseType.StatusCode.ToString();
            var response = operation.Responses[responseKey];

            foreach (var contentType in response.Content.Keys)
            {
                if (!responseType.ApiResponseFormats.Any(x => x.MediaType == contentType))
                {
                    response.Content.Remove(contentType);
                }
            }
        }

        if (operation.Parameters is null)
        {
            return;
        }


        foreach (var parameter in operation.Parameters)
        {
            var description = apiDescription.ParameterDescriptions.First(p => p.Name == parameter.Name);

            parameter.Description ??= description.ModelMetadata?.Description;

            if (parameter.Schema.Default is null &&
                 description.DefaultValue is not null &&
                 description.DefaultValue is not DBNull &&
                 description.ModelMetadata is ModelMetadata modelMetadata)
            {

                var json = JsonSerializer.Serialize(description.DefaultValue, modelMetadata.ModelType);
                parameter.Schema.Default = OpenApiAnyFactory.CreateFromJson(json);
            }

            parameter.Required |= description.IsRequired;
        }
    }
}

Swagger 依賴注入

builder.Services.AddSwaggerGen(options => options.OperationFilter<SwaggerDefaultValues>());

UseSwaggerUI 新增 Swagger 終結點

    app.UseSwaggerUI(options =>
    {
        var descriptions = app.DescribeApiVersions();
        // build a swagger endpoint for each discovered API version
        foreach (var description in descriptions)
        {
            var url = $"/swagger/{description.GroupName}/swagger.json";
            var name = description.GroupName.ToUpperInvariant();
            options.SwaggerEndpoint(url, name);
        }
    });

Run Swagger 檢視專案

image

左上角可以成功切換版本，OpenApi 版本管理成功

最後

本文的 demo 用了aspnet-api-versioning版本控制的一種方式來做的演示，WebApi Controller 配置好 Options 之後只需要用aspnet-api-versioning提供的 Attribute 就可以實現版本管理，Route Path 和 httpHeader 等傳引數的方式只需要微調就可以實現，更多高階功能請瀏覽aspnet-api-versioning官網(文末有官網地址)。

Api 版本控制是設計現代 Api 的最佳實踐之一。從第一個版本開始實現 Api 版本控制,這樣可以更容易地讓客戶端支援未來的 Api 版本,同時也讓您的團隊習慣於管理破壞性變化和對 Api 進行版本控制。

以下是本文的完整 原始碼

aspnet-api-versioning 官網學習文件

相關文章