Beetlex服務框架之Webapi版本訪問控制

在應用服務中API更新是很普遍的事情，為了服務良好地運作很多時候需要新舊版本同時兼容；為了應對這一系列的需求FastHttpApi在新版中強化了Url重寫機制來支持API訪問版本控制，由原來固定的重寫規則調整成支持動態數據的重寫規則，主要支持域名，header和querystring等不同值進一個重寫的定義。接下來講解如何通過FastHttpApi來控制不同版本的API訪問

API示例

    [Controller(BaseUrl = "Api")]
    public class Api
    {
        public object Hello(string name)
        {
            return $"hello {name} at {DateTime.Now}";
        }
    }
    [Controller(BaseUrl = "Api/v2")]
    public class ApiV2
    {
        public object Hello(string name)
        {
            return $"hello {name} at {DateTime.Now}[v2]";
        }
    }

以上是兩個不同版本的API功能，訪問的Url分別是/Api/hello和/Api/v2/hello

 

其實有很多時候希望不改變Url路徑的情況來對不同版本來進行一訪問，這樣在使用調整上就比較方便簡單。FastHttpApi支持通過域名，請求頭和請求參數來應對不同情況的重寫，這樣就可以讓調用者無法關注訪問的路徑統一設置相關參數即可。

依據域名重寫

組件支持依據域名來重寫Url,針對這情況可以定義一個V2.beetlex.com來訪問/Api/v2/hello，在程序啟動的時候加入一個重寫

static void Main(string[] args)
{
    var builder = new HostBuilder()
        .ConfigureServices((hostContext, services) =>
        {
            services.UseBeetlexHttp(o =>
            {
                o.AddFilter<DefaultJsonResultFilter>();
                o.LogToConsole = true;
                o.Port = 80;
                o.SetDebug();
                o.LogLevel = BeetleX.EventArgs.LogType.Info;
            },
            b =>
            {
                b.UrlRewrite
                .Add("v2.beetlex.com", "/api/{action}", "/api/v2/{action}");
            },
            typeof(Program).Assembly);
        });
    builder.Build().Run();
}

只要是通過V2.beetlex.com訪問的/api/{action}重寫到/api/v2/{action},重寫后訪問的結果如下:

一般情況很少會用域名來區分，用域名區分的場更多是正式和測試API的兼容部署，測試完成后會替換原則有的API;后面會講述如何接管舊的請求到新的版本中。

依據Header或QueryString值來重寫

其實在Header中添加則是對整個Url是沒有任何影響的，組件可以這樣定義這個重寫規則

static void Main(string[] args)
{
    var builder = new HostBuilder()
        .ConfigureServices((hostContext, services) =>
        {
            services.UseBeetlexHttp(o =>
            {
                o.AddFilter<DefaultJsonResultFilter>();
                o.LogToConsole = true;
                o.Port = 80;
                o.SetDebug();
                o.LogLevel = BeetleX.EventArgs.LogType.Info;
            },
            b =>
            {
                b.UrlRewrite
                .Add("version=v2", "/api/{action}", "/api/v2/{action}")
            },
            typeof(Program).Assembly);
        });
    builder.Build().Run();
}

以上是配置一個version變量，只要這個變量是等於v2的情況則會觸發這個重寫規則；組件會先從請求頭中獲取，獲取不了的情況再從Url請求數據中獲取。使用效果如下:

由於瀏覽器不方便添加header,通過Postman添加版本頭來測試

版本替換

如果服務是一個新舊版本替換的情況下則可以重寫Url,把訪問舊的api路徑指向新的api路徑。

static void Main(string[] args)
{
    var builder = new HostBuilder()
        .ConfigureServices((hostContext, services) =>
        {
            services.UseBeetlexHttp(o =>
            {
                o.AddFilter<DefaultJsonResultFilter>();
                o.LogToConsole = true;
                o.Port = 80;
                o.SetDebug();
                o.LogLevel = BeetleX.EventArgs.LogType.Info;
            },
            b =>
            {
                b.UrlRewrite
                .Add("/api/{action}", "/api/v2/{action}");
            },
            typeof(Program).Assembly);
        });
    builder.Build().Run();
}

提醒

其實組件UrlRewrite是支持運行時動態更新，只需要做個管理頁即可隨時調整API不同版本的訪問處理。

了解更多框架webapi功能可以訪問https://github.com/IKende/FastHttpApi/wiki