@midwayjs/koa 4.0.0-beta.2 → 4.0.0-beta.3

package/README.md

@@ -9,4 +9,4 @@ Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 
-[MIT]((https://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT](https://github.com/midwayjs/midway/blob/master/LICENSE)

package/dist/framework.d.ts

@@ -26,5 +26,7 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
     getPort(): string;
     useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void;
     useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -137,10 +137,16 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
                 throw new core_1.httpError.NotFoundError(`${ctx.path} Not Found`);
             }
         };
+        const applyMiddlewares = [notFound];
+        // versioning middleware
+        const versioningConfig = this.configurationOptions.versioning;
+        if (versioningConfig?.enabled) {
+            applyMiddlewares.push(this.createVersioningMiddleware(versioningConfig));
+        }
         // root middleware
         const midwayRootMiddleware = async (ctx, next) => {
             this.app.createAnonymousContext(ctx);
-            await (await this.applyMiddleware(notFound))(ctx, next);
+            await (await this.applyMiddleware(applyMiddlewares))(ctx, next);
             if (ctx.body === undefined &&
                 !ctx.response._explicitStatus &&
                 ctx._matchedRoute) {
@@ -266,6 +272,52 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     useFilter(Filter) {
         this.filterManager.useFilter(Filter);
     }
+    createVersioningMiddleware(config) {
+        return async (ctx, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(ctx, config);
+            ctx.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (ctx.path.startsWith(versionPrefix)) {
+                    ctx.originalPath = ctx.path;
+                    ctx.path = ctx.path.replace(versionPrefix, '') || '/';
+                }
+            }
+            await next();
+        };
+    }
+    extractVersion(ctx, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(ctx);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = ctx.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = ctx.headers.accept;
+                const paramName = config.mediaTypeParam || 'version';
+                const match = accept?.match(new RegExp(`${paramName}=(\\d+)`));
+                return match ? match[1] : undefined;
+            }
+            case 'URI': {
+                const prefix = config.prefix || 'v';
+                const uriMatch = ctx.path.match(new RegExp(`^/${prefix}(\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayKoaFramework = MidwayKoaFramework;
 exports.MidwayKoaFramework = MidwayKoaFramework = __decorate([

package/dist/interface.d.ts

@@ -100,6 +100,39 @@ export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
      * listen options
      */
     listenOptions?: ListenOptions;
+    /**
+     * 版本控制配置
+     */
+    versioning?: {
+        /**
+         * 是否启用版本控制
+         */
+        enabled?: boolean;
+        /**
+         * 默认版本控制类型
+         */
+        type?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+        /**
+         * 默认版本
+         */
+        defaultVersion?: string;
+        /**
+         * URI 版本前缀，默认为 'v'
+         */
+        prefix?: string;
+        /**
+         * Header 版本控制时的 header 名称
+         */
+        header?: string;
+        /**
+         * Media Type 版本控制时的参数名
+         */
+        mediaTypeParam?: string;
+        /**
+         * 自定义版本提取函数
+         */
+        extractVersionFn?: (ctx: IMidwayKoaContext) => string | undefined;
+    };
 }
 export type MiddlewareParamArray = Array<Middleware<DefaultState, IMidwayKoaContext>>;
 export interface IWebMiddleware {
@@ -108,6 +141,8 @@ export interface IWebMiddleware {
 export type Application = IMidwayKoaApplication;
 export interface Context extends IMidwayKoaContext {
     state: State;
+    apiVersion?: string;
+    originalPath?: string;
 }
 export interface BodyParserOptions {
     enable?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/koa",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.3",
   "description": "Midway Web Framework for KOA",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,8 +24,8 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.2",
-    "@midwayjs/mock": "^4.0.0-beta.2",
+    "@midwayjs/core": "^4.0.0-beta.3",
+    "@midwayjs/mock": "^4.0.0-beta.3",
     "@types/koa-router": "7.4.8",
     "axios": "1.12.0",
     "fs-extra": "11.3.0"
@@ -33,7 +33,7 @@
   "dependencies": {
     "@koa/router": "^12.0.0",
     "@midwayjs/cookies": "^1.3.0",
-    "@midwayjs/session": "^4.0.0-beta.2",
+    "@midwayjs/session": "^4.0.0-beta.3",
     "@types/koa": "3.0.0",
     "@types/qs": "6.9.18",
     "koa": "3.0.1",
@@ -48,5 +48,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "53bfef4c5279da5f09025e4610bdbf64f94f60bd"
+  "gitHead": "b5b7dfaafb81823cdba5fd10ad2709b3e495c6b4"
 }