@midwayjs/web 4.0.0-beta.1 → 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/web.d.ts

@@ -22,5 +22,7 @@ export declare class MidwayWebFramework extends BaseFramework<Application, Conte
     generateMiddleware(middlewareId: any): Promise<any>;
     beforeStop(): Promise<void>;
     setServer(server: any): void;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=web.d.ts.map

package/dist/framework/web.js

@@ -15,6 +15,7 @@ const router_1 = require("@eggjs/router");
 const logger_1 = require("@midwayjs/logger");
 const path_1 = require("path");
 const util_1 = require("util");
+const net_1 = require("net");
 const debug = (0, util_1.debuglog)('midway:debug');
 class EggControllerGenerator extends core_1.WebControllerGenerator {
     constructor(app, webRouterService) {
@@ -79,9 +80,15 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
                 throw new core_1.httpError.NotFoundError(`${ctx.path} Not Found`);
             }
         };
+        const applyMiddlewares = [midwayRouterNotFound];
+        const versioningConfig = this.configurationOptions.versioning;
+        // 如果启用版本控制，添加版本处理中间件
+        if (versioningConfig?.enabled) {
+            applyMiddlewares.push(this.createVersioningMiddleware(versioningConfig));
+        }
         // insert error handler
         const midwayRootMiddleware = async (ctx, next) => {
-            await (await this.applyMiddleware(midwayRouterNotFound))(ctx, next);
+            await (await this.applyMiddleware(applyMiddlewares))(ctx, next);
         };
         this.app.use(midwayRootMiddleware);
         this.webRouterService = await this.applicationContext.getAsync(core_1.MidwayWebRouterService, [
@@ -200,7 +207,10 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
             this.getApplicationContext().registerObject(core_1.HTTP_SERVER_KEY, this.server);
             const eggConfig = this.configService.getConfiguration('egg');
             if (!this.isClusterMode && eggConfig) {
-                const customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+                let customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+                if (customPort === 0) {
+                    customPort = await getFreePort();
+                }
                 if (customPort) {
                     new Promise(resolve => {
                         const args = [customPort];
@@ -251,6 +261,52 @@ let MidwayWebFramework = class MidwayWebFramework extends core_1.BaseFramework {
     setServer(server) {
         this.server = server;
     }
+    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.MidwayWebFramework = MidwayWebFramework;
 __decorate([
@@ -260,4 +316,19 @@ __decorate([
 exports.MidwayWebFramework = MidwayWebFramework = __decorate([
     (0, core_1.Framework)()
 ], MidwayWebFramework);
+async function getFreePort() {
+    return new Promise((resolve, reject) => {
+        const server = (0, net_1.createServer)();
+        server.listen(0, () => {
+            try {
+                const port = server.address().port;
+                server.close();
+                resolve(port);
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    });
+}
 //# sourceMappingURL=web.js.map

package/dist/interface.d.ts

@@ -61,6 +61,14 @@ export interface Context<ResponseBodyT = unknown> extends IMidwayWebContext<Resp
         [_: string]: any;
     };
     state: State;
+    /**
+     * API version extracted from request
+     */
+    apiVersion?: string;
+    /**
+     * Original path before version processing
+     */
+    originalPath?: string;
 }
 /**
  * @deprecated since version 3.0.0
@@ -120,6 +128,39 @@ export interface IMidwayWebConfigurationOptions extends IConfigurationOptions {
      * https/https/http2 server options
      */
     serverOptions?: Record<string, any>;
+    /**
+     * API versioning configuration
+     */
+    versioning?: {
+        /**
+         * Enable versioning
+         */
+        enabled: boolean;
+        /**
+         * Versioning type
+         */
+        type?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+        /**
+         * Default version if none is specified
+         */
+        defaultVersion?: string;
+        /**
+         * Version prefix for URI versioning (default: 'v')
+         */
+        prefix?: string;
+        /**
+         * Header name for HEADER versioning (default: 'x-api-version')
+         */
+        header?: string;
+        /**
+         * Media type parameter name for MEDIA_TYPE versioning (default: 'version')
+         */
+        mediaTypeParam?: string;
+        /**
+         * Custom version extraction function
+         */
+        extractVersionFn?: (ctx: Context) => string | undefined;
+    };
 }
 /**
  * @deprecated since version 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/web",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.3",
   "description": "Midway Web Framework for Egg.js",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -29,7 +29,7 @@
   "license": "MIT",
   "devDependencies": {
     "@midwayjs/logger": "^3.0.0",
-    "@midwayjs/mock": "^4.0.0-beta.1",
+    "@midwayjs/mock": "^4.0.0-beta.3",
     "@types/koa": "2.15.0",
     "dayjs": "1.11.13",
     "egg-logger": "3.6.1",
@@ -49,7 +49,7 @@
   },
   "dependencies": {
     "@eggjs/router": "^2.0.0",
-    "@midwayjs/core": "^4.0.0-beta.1",
+    "@midwayjs/core": "^4.0.0-beta.3",
     "egg": "^2.28.0",
     "egg-cluster": "^1.27.1",
     "egg-path-matching": "^2.1.0",
@@ -63,7 +63,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
+  "gitHead": "b5b7dfaafb81823cdba5fd10ad2709b3e495c6b4"
 }