@midwayjs/express 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

@@ -31,5 +31,7 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
     getServer(): Server;
     getPort(): string;
     getFrameworkName(): string;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -31,6 +31,12 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             ctx.requestContext.registerObject('res', res);
             next();
         });
+        // 版本控制配置
+        const versioningConfig = this.configurationOptions.versioning;
+        // 如果启用版本控制，添加版本处理中间件
+        if (versioningConfig?.enabled) {
+            this.app.use(this.createVersioningMiddleware(versioningConfig));
+        }
         this.defineApplicationProperties({
             useMiddleware: (routerPath, ...middleware) => {
                 if (typeof routerPath === 'string' && middleware) {
@@ -294,6 +300,53 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     getFrameworkName() {
         return 'express';
     }
+    createVersioningMiddleware(config) {
+        return (req, res, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(req, config);
+            req.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (req.path.startsWith(versionPrefix)) {
+                    req.originalPath = req.path;
+                    // Express 中需要修改 url 而不是 path
+                    req.url = req.url.replace(versionPrefix, '') || '/';
+                }
+            }
+            next();
+        };
+    }
+    extractVersion(req, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(req);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = req.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = req.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 = req.path.match(new RegExp(`^/${prefix}(\\\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayExpressFramework = MidwayExpressFramework;
 exports.MidwayExpressFramework = MidwayExpressFramework = __decorate([

package/dist/interface.d.ts

@@ -8,6 +8,14 @@ type Request = IMidwayContext<ExpressRequest>;
 export type Response = ExpressResponse;
 export type NextFunction = ExpressNextFunction;
 export interface Context extends Request {
+    /**
+     * API version extracted from request
+     */
+    apiVersion?: string;
+    /**
+     * Original path before version processing
+     */
+    originalPath?: string;
 }
 /**
  * @deprecated use Context
@@ -76,6 +84,39 @@ export interface IMidwayExpressConfigurationOptions extends IConfigurationOption
      * listen options
      */
     listenOptions?: ListenOptions;
+    /**
+     * 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;
+    };
 }
 export type Application = IMidwayExpressApplication;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/express",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.3",
   "description": "Midway Web Framework for Express",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,14 +24,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.2",
-    "@midwayjs/mock": "^4.0.0-beta.2",
-    "@types/body-parser": "1.19.5",
+    "@midwayjs/core": "^4.0.0-beta.3",
+    "@midwayjs/mock": "^4.0.0-beta.3",
+    "@types/body-parser": "1.19.6",
     "@types/express": "4.17.23",
     "fs-extra": "11.3.0"
   },
   "dependencies": {
-    "@midwayjs/express-session": "^4.0.0-beta.2",
+    "@midwayjs/express-session": "^4.0.0-beta.3",
     "body-parser": "1.20.3",
     "cookie-parser": "^1.4.6",
     "express": "4.21.2"
@@ -44,5 +44,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "53bfef4c5279da5f09025e4610bdbf64f94f60bd"
+  "gitHead": "b5b7dfaafb81823cdba5fd10ad2709b3e495c6b4"
 }