武裝你的WEBAPI-OData Versioning

波多爾斯基發表於2023-05-05
WebAPI

本文屬於OData系列

目錄

對外提供WEBAPI時，如果遇上了版本升級，那麼控制WEBAPI的版本也是非常必要的。OData官方提供了版本控制以及管理的解決方案，我個人是實踐體會是不好用，好在社群提供了對應的nuget包，與.NET主版本同步更新。

介紹

ASP.NET API Versioning是一個提供ASP.NET WEBAPI版本管理的包，支援ASP.NET、ASP.NET CORE、ASP.NET CORE ODATA，作者以前是微軟的員工，現在不在微軟工作了，因此原先的名稱空間不能繼續用了。現在這個專案已經加入.NET Foundation，作者也非常活躍。

版本管理

首先對現有的專案安裝這個包：

Install-Package Asp.Versioning.OData

在Program.cs檔案中修改一下：

var builder = WebApplication.CreateBuilder( args );

builder.Services.AddControllers().AddOData();
builder.Services.AddProblemDetails();
builder.Services.AddApiVersioning().AddOData(
    options =>
    {
        options.AddRouteComponents();
    } );

var app = builder.Build();

app.MapControllers();
app.Run();

然後在需要控制版本的控制器上加上[ApiVersion]修飾就可以了。

[ApiVersion( 1.0 )]
public class PeopleController : ODataController
{
    [EnableQuery]
    public IActionResult Get() => Ok( new[] { new Person() } );
}

注意，預設的版本是1.0，不過最好顯式宣告一下。

EDM升級

EDM根據版本不同也會有一些區別，需要分別進行配置，原來的GetEdm()模式顯得有點麻煩，而EDM配置在這個庫中變得非常靈活，使用的是Configuration模式。

示例程式碼如下：

public class DeviceInfoModelConfiguration : IModelConfiguration
{
	public void Apply(ODataModelBuilder builder, ApiVersion apiVersion, string routePrefix)
	{
		switch (apiVersion.MajorVersion)
		{
			case 1:
				builder.EntitySet<DeviceInfo>("DeviceInfoes").EntityType.HasKey(p => p.DeviceId);
				break;
			case 2:
				builder.EntitySet<DeviceInfo>("DeviceInfos").EntityType.HasKey(p => p.DeviceId).Ignore(w => w.Layout);
				break;
			default:
				break;
		};
	}
}

只需要實現IModelConfiguration介面，並在Apply函式中根據版本對實體或者DTO物件進行配置，不同版本的EDM可以不一樣。

一般實踐是一個實體物件一個IModelConfiguration，方便後面管理。

配置Swagger

因為有重複配置的模型，直接使用預設的Swagger會報錯，這個時候需要使用到Versioned API Explorer，對Swagger擴充版本資訊。

Install-Package Asp.Versioning.OData.ApiExplorer

安裝Asp.Versioning.OData.ApiExplorer，重新改造一下Program.cs檔案：

var builder = WebApplication.CreateBuilder( args );

builder.Services.AddControllers().AddOData();
builder.Services.AddProblemDetails();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddApiVersioning()
                .AddOData( options => options.AddRouteComponents() )
                .AddODataApiExplorer(
                     // format the version as "'v'major[.minor][-status]"
                     options => options.GroupNameFormat = "'v'VVV" );

services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();
services.AddSwaggerGen();

var app = builder.Build();

app.UseSwagger();
app.UseSwaggerUI(
    options =>
    {
        foreach ( var description in app.DescribeApiVersions() )
        {
            var url = $"/swagger/{description.GroupName}/swagger.json";
            var name = description.GroupName.ToUpperInvariant();
            options.SwaggerEndpoint( url, name );
        }
    } );
app.MapControllers();
app.Run();

還需要一個配置的類如下：

public class ConfigureSwaggerOptions : IConfigureOptions<SwaggerGenOptions>
{
  readonly IApiVersionDescriptionProvider provider;

  public ConfigureSwaggerOptions( IApiVersionDescriptionProvider provider ) =>
    this.provider = provider;

  public void Configure( SwaggerGenOptions options )
  {
    foreach ( var description in provider.ApiVersionDescriptions )
    {
      options.SwaggerDoc(
        description.GroupName,
          new OpenApiInfo()
          {
            Title = $"Example API {description.ApiVersion}",
            Version = description.ApiVersion.ToString(),
          } );
    }
  }
}

這樣，swagger介面就可以下拉選擇不同版本的API了。

舊系統升級

WEBAPI Versioning對這個內容有介紹，其中需要注意的是，基於路徑的版本匹配並不支援預設版本的特性，對於以前系統直接使用api/開頭的控制器，並不能直接預設轉到到api/v1（參考介紹）。為了相容舊系統，我們只能在ASP.NET CORE的管線上想想辦法：插入一箇中介軟體，對路徑進行判斷，如果是api開頭的，就直接轉到api/v1；如果是api/v開頭的，那麼就直接下一步。

    public class RedirectMiddlewareForV1
    {
        private readonly RequestDelegate _next;

        public RedirectMiddlewareForV1(RequestDelegate next)
        {
            _next = next;
        }

        public async Task InvokeAsync(HttpContext context)
        {
            if (context.Request.Path.StartsWithSegments("/api") && !context.Request.Path.Value.StartsWith("/api/v"))
            {
                //千萬小心，一定需要保留原來的QueryString
                var newUrl = $"{context.Request.Path.Value.Replace("/api/", "/api/v1/")}{context.Request.QueryString}";
                //permanent指示永久遷移,preserveMethod指示保留原來的謂詞與body
                context.Response.Redirect(newUrl, permanent: true, preserveMethod: true);
            }
            else
            {
                await _next(context);
            }
        }


    }

然後在configure函式中註冊這個中介軟體就可以了。

app.UseMiddleware<RedirectMiddlewareForV1>();

請注意:

  • context.Request.Path.StartsWithSegments函式只能匹配完整的路徑詞彙，/api/v2去匹配/api/v會返回false。
  • 另外需要了解HTTP 301/302/307/308之間的區別，如果需要保留原來的請求body，需要使用307/308，308是永久移動。
  • Redirect並不保留原來的QueryString，需要手動拼接。

FAQ

  1. 無法正確顯示不同版本的Swagger，提示InvalidOperationException: Can't use schemaId "\(B" for type "\)A.B". The same schemaId is already used for type "$A.B"
    這個問題是由多次對同一個型別Schema生成造成的。最常見的情況是你的控制器有方法不屬於OData Routing的一部分（比如直接使用HttpGet指定），這樣程式在掃描的過程中會重複對物件進行生成。解決辦法有兩種：
  1. 無法載入Swagger，提示System.MissingMethodException: Method not found: 'Microsoft.OData.ModelBuilder.Config.DefaultQuerySettings Microsoft.AspNetCore.OData.ODataOptions.get_QuerySettings()
    這個是版本問題，本人使用的OData版本在8.1.0，有一些破壞性更改，只要保持引用的OData版本<= 8.0.12就可以了。
    詳細分析看這個MissingMethodException with OData v8.1.0 · Issue #980 · dotnet/aspnet-api-versioning (github.com)
  2. 找不到DescribeApiVersions()方法
    app找不到這個方法，大機率是在.NET 6的Minimal API之前的程式碼升級出現的，之前app是用IWebhostBuilder構建的，而現在的app是直接用過WebApplication構建得到的，含義不同，最簡單的方法是改造一下，使用WebApplication重寫一下Startup內容。

參考

相關文章