@midwayjs/swagger 3.0.4-beta.1 → 3.0.7

package/dist/configuration.d.ts

@@ -1,6 +1,7 @@
-import { ILifeCycle, IMidwayContainer, MidwayApplicationManager } from '@midwayjs/core';
+import { ILifeCycle, IMidwayContainer, MidwayApplicationManager, MidwayConfigService } from '@midwayjs/core';
 export declare class SwaggerConfiguration implements ILifeCycle {
     applicationManager: MidwayApplicationManager;
+    configService: MidwayConfigService;
     onReady(container: IMidwayContainer): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -16,19 +16,34 @@ const _1 = require(".");
 const DefaultConfig = require("./config/config.default");
 let SwaggerConfiguration = class SwaggerConfiguration {
     async onReady(container) {
-        this.applicationManager
-            .getApplications(['express', 'koa', 'egg', 'faas'])
-            .forEach(app => {
-            app.useMiddleware(_1.SwaggerMiddleware);
-        });
-        const explorer = await container.getAsync(_1.SwaggerExplorer);
-        explorer.scanApp();
+        const apps = this.applicationManager.getApplications([
+            'express',
+            'koa',
+            'egg',
+            'faas',
+        ]);
+        if (apps.length) {
+            const globalPrefix = this.configService.getConfiguration('globalPrefix') ||
+                this.configService.getConfiguration('koa.globalPrefix') ||
+                this.configService.getConfiguration('express.globalPrefix') ||
+                this.configService.getConfiguration('egg.globalPrefix');
+            const explorer = await container.getAsync(_1.SwaggerExplorer);
+            explorer.addGlobalPrefix(globalPrefix);
+            explorer.scanApp();
+            apps.forEach(app => {
+                app.useMiddleware(_1.SwaggerMiddleware);
+            });
+        }
     }
 };
 __decorate([
     (0, decorator_1.Inject)(),
     __metadata("design:type", core_1.MidwayApplicationManager)
 ], SwaggerConfiguration.prototype, "applicationManager", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayConfigService)
+], SwaggerConfiguration.prototype, "configService", void 0);
 SwaggerConfiguration = __decorate([
     (0, decorator_1.Configuration)({
         importConfigs: [

package/dist/decorators/api-tags.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiTags(...tags: string[]): any;
+export declare function ApiTags(tags: string | string[]): any;
 //# sourceMappingURL=api-tags.decorator.d.ts.map

package/dist/decorators/api-tags.decorator.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiTags = void 0;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
-function ApiTags(...tags) {
+function ApiTags(tags) {
     return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_TAGS, tags);
 }
 exports.ApiTags = ApiTags;

package/dist/documentBuilder.d.ts

@@ -9,7 +9,6 @@ export declare class DocumentBuilder {
     setLicense(name: string, url: string): this;
     addServer(url: string, description?: string, variables?: Record<string, ServerVariableObject>): this;
     setExternalDoc(description: string, url: string): this;
-    setBasePath(path: string | string[]): this;
     addPaths(paths: Record<string, PathItemObject>): this;
     addSchema(schema: Record<string, SchemaObject>): this;
     getSchema(name: string): SchemaObject;

package/dist/documentBuilder.js

@@ -49,23 +49,6 @@ class DocumentBuilder {
         this.document.externalDocs = { description, url };
         return this;
     }
-    setBasePath(path) {
-        if (this.document.basePath) {
-            if (Array.isArray(this.document.basePath)) {
-                this.document.basePath.push(path);
-            }
-            else {
-                this.document.basePath = [
-                    this.document.basePath,
-                    path,
-                ];
-            }
-        }
-        else {
-            this.document.basePath = path;
-        }
-        return this;
-    }
     addPaths(paths) {
         Object.assign(this.document.paths, paths);
         return this;

package/dist/interfaces/index.d.ts

@@ -326,10 +326,6 @@ export interface SwaggerOptions {
      * 可以参考 https://swagger.io/specification/#security-scheme-object
      */
     auth?: AuthOptions | AuthOptions[];
-    /**
-     * api 的 根路径
-     */
-    basePath?: string | string[];
     /**
      * 默认值: /swagger-ui
      * 访问 swagger ui 的路径

package/dist/swaggerExplorer.d.ts

@@ -2,6 +2,7 @@ export declare class SwaggerExplorer {
     private swaggerConfig;
     private documentBuilder;
     init(): Promise<void>;
+    addGlobalPrefix(prefix: string): void;
     scanApp(): void;
     getData(): Omit<import("./interfaces").OpenAPIObject, "paths">;
     private generatePath;
@@ -9,6 +10,7 @@ export declare class SwaggerExplorer {
      * 构造 router 提取方法
      */
     private generateRouteMethod;
+    private expandSchemaRef;
     /**
      * 提取参数
      * @param params

package/dist/swaggerExplorer.js

@@ -31,9 +31,6 @@ let SwaggerExplorer = class SwaggerExplorer {
             typeof ((_k = this.swaggerConfig) === null || _k === void 0 ? void 0 : _k.license) === 'object') {
             this.documentBuilder.setLicense((_m = (_l = this.swaggerConfig) === null || _l === void 0 ? void 0 : _l.license) === null || _m === void 0 ? void 0 : _m.name, (_p = (_o = this.swaggerConfig) === null || _o === void 0 ? void 0 : _o.license) === null || _p === void 0 ? void 0 : _p.url);
         }
-        if (this.swaggerConfig.basePath) {
-            this.documentBuilder.setBasePath(this.swaggerConfig.basePath);
-        }
         if (this.swaggerConfig.termsOfService) {
             this.documentBuilder.setTermsOfService(this.swaggerConfig.termsOfService);
         }
@@ -44,7 +41,7 @@ let SwaggerExplorer = class SwaggerExplorer {
         if (((_w = this.swaggerConfig) === null || _w === void 0 ? void 0 : _w.servers) &&
             Array.isArray((_x = this.swaggerConfig) === null || _x === void 0 ? void 0 : _x.servers)) {
             for (const serv of (_y = this.swaggerConfig) === null || _y === void 0 ? void 0 : _y.servers) {
-                this.documentBuilder.addServer(serv === null || serv === void 0 ? void 0 : serv.url, serv === null || serv === void 0 ? void 0 : serv.description);
+                this.documentBuilder.addServer(serv === null || serv === void 0 ? void 0 : serv.url, serv === null || serv === void 0 ? void 0 : serv.description, serv === null || serv === void 0 ? void 0 : serv.variables);
             }
         }
         if (((_z = this.swaggerConfig) === null || _z === void 0 ? void 0 : _z.tags) && Array.isArray((_0 = this.swaggerConfig) === null || _0 === void 0 ? void 0 : _0.tags)) {
@@ -62,6 +59,12 @@ let SwaggerExplorer = class SwaggerExplorer {
             this.setAuth((_5 = this.swaggerConfig) === null || _5 === void 0 ? void 0 : _5.auth);
         }
     }
+    addGlobalPrefix(prefix) {
+        if (!prefix) {
+            return;
+        }
+        this.documentBuilder.addServer(prefix);
+    }
     scanApp() {
         var _a;
         const routes = (0, decorator_1.listModule)(decorator_1.CONTROLLER_KEY);
@@ -132,7 +135,17 @@ let SwaggerExplorer = class SwaggerExplorer {
                 if (endpoints[0]) {
                     continue;
                 }
-                this.generateRouteMethod(url, webRouter, paths, metaForMethods, metaForParams, header, target);
+                const routerArgs = metaForParams[webRouter.method] || [];
+                const bds = routerArgs.filter(item => {
+                    var _a;
+                    return item.key === decorator_1.WEB_ROUTER_PARAM_KEY &&
+                        ((_a = item === null || item === void 0 ? void 0 : item.metadata) === null || _a === void 0 ? void 0 : _a.type) === decorator_1.RouteParamTypes.BODY;
+                });
+                if (bds.length > 1) {
+                    // swagger not support more than one @Body
+                    continue;
+                }
+                this.generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, header, target);
                 // 这里赋值 tags
                 if (paths[url][webRouter.requestMethod].tags.length === 0) {
                     paths[url][webRouter.requestMethod].tags = strTags;
@@ -163,8 +176,8 @@ let SwaggerExplorer = class SwaggerExplorer {
     /**
      * 构造 router 提取方法
      */
-    generateRouteMethod(url, webRouter, paths, metaForMethods, metaForParams, header, target) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, header, target) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const operMeta = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_OPERATION &&
             item.propertyName === webRouter.method)[0];
         let opts = paths[url];
@@ -175,25 +188,23 @@ let SwaggerExplorer = class SwaggerExplorer {
         opts[webRouter.requestMethod] = {
             summary: (_a = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _a === void 0 ? void 0 : _a.summary,
             description: (_b = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _b === void 0 ? void 0 : _b.description,
-            operationId: ((_c = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _c === void 0 ? void 0 : _c.operationId) || webRouter.method,
-            tags: ((_d = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _d === void 0 ? void 0 : _d.tags) || [],
+            // operationId: `${webRouter.requestMethod}_${(operMeta?.metadata?.operationId || webRouter.method)}`,
+            tags: ((_c = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _c === void 0 ? void 0 : _c.tags) || [],
         };
         /**
          * [{"key":"web:router_param","parameterIndex":1,"propertyName":"create","metadata":{"type":2}},
          * {"key":"web:router_param","parameterIndex":0,"propertyName":"create","metadata":{"type":1,"propertyData":"createCatDto"}}]
          */
-        const routerArgs = metaForParams[webRouter.method] || [];
         // WEB_ROUTER_PARAM_KEY
-        let args = routerArgs.filter(item => item.key === decorator_1.WEB_ROUTER_PARAM_KEY);
-        args = args.filter(item => item.key === decorator_1.WEB_ROUTER_PARAM_KEY);
+        const args = routerArgs.filter(item => item.key === decorator_1.WEB_ROUTER_PARAM_KEY);
         const types = (0, decorator_1.getMethodParamTypes)(target, webRouter.method);
         const params = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_PARAMETERS &&
             item.propertyName === webRouter.method);
         for (const arg of args) {
             const currentType = types[arg.parameterIndex];
             const p = {
-                name: (_f = (_e = arg === null || arg === void 0 ? void 0 : arg.metadata) === null || _e === void 0 ? void 0 : _e.propertyData) !== null && _f !== void 0 ? _f : '',
-                in: convertTypeToString((_g = arg.metadata) === null || _g === void 0 ? void 0 : _g.type),
+                name: (_e = (_d = arg === null || arg === void 0 ? void 0 : arg.metadata) === null || _d === void 0 ? void 0 : _d.propertyData) !== null && _e !== void 0 ? _e : '',
+                in: convertTypeToString((_f = arg.metadata) === null || _f === void 0 ? void 0 : _f.type),
                 required: false,
             };
             if (p.in === 'path') {
@@ -210,13 +221,16 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
             else {
                 p.schema = {
-                    type: convertSchemaType((_h = currentType === null || currentType === void 0 ? void 0 : currentType.name) !== null && _h !== void 0 ? _h : currentType),
+                    type: convertSchemaType((_g = currentType === null || currentType === void 0 ? void 0 : currentType.name) !== null && _g !== void 0 ? _g : currentType),
                 };
             }
             this.parseFromParamsToP(params[params.length - 1 - arg.parameterIndex], p);
             if (p.in === 'body') {
+                if (webRouter.requestMethod === decorator_1.RequestMethod.GET) {
+                    continue;
+                }
                 // 这里兼容一下 @File()、@Files()、@Fields() 装饰器
-                if (((_j = arg.metadata) === null || _j === void 0 ? void 0 : _j.type) === decorator_1.RouteParamTypes.FILESSTREAM) {
+                if (((_h = arg.metadata) === null || _h === void 0 ? void 0 : _h.type) === decorator_1.RouteParamTypes.FILESSTREAM) {
                     p.schema = {
                         type: 'object',
                         properties: {
@@ -232,7 +246,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     };
                     p.contentType = _1.BodyContentType.Multipart;
                 }
-                if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === decorator_1.RouteParamTypes.FILESTREAM) {
+                if (((_j = arg.metadata) === null || _j === void 0 ? void 0 : _j.type) === decorator_1.RouteParamTypes.FILESTREAM) {
                     p.schema = {
                         type: 'object',
                         properties: {
@@ -245,14 +259,8 @@ let SwaggerExplorer = class SwaggerExplorer {
                     };
                     p.contentType = _1.BodyContentType.Multipart;
                 }
-                if (((_l = arg.metadata) === null || _l === void 0 ? void 0 : _l.type) === decorator_1.RouteParamTypes.FIELDS) {
-                    if (p.schema['$ref']) {
-                        // 展开各个字段属性
-                        const name = p.schema['$ref'].replace('#/components/schemas/', '');
-                        const schema = this.documentBuilder.getSchema(name);
-                        delete p.schema['$ref'];
-                        p.schema = JSON.parse(JSON.stringify(schema));
-                    }
+                if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === decorator_1.RouteParamTypes.FIELDS) {
+                    this.expandSchemaRef(p);
                     p.contentType = _1.BodyContentType.Multipart;
                 }
                 if (!p.content) {
@@ -349,6 +357,23 @@ let SwaggerExplorer = class SwaggerExplorer {
         }
         paths[url] = opts;
     }
+    expandSchemaRef(p, name) {
+        let schemaName = name;
+        if (p.schema['$ref']) {
+            // 展开各个字段属性
+            schemaName = p.schema['$ref'].replace('#/components/schemas/', '');
+            delete p.schema['$ref'];
+        }
+        const schema = this.documentBuilder.getSchema(schemaName);
+        const ss = JSON.parse(JSON.stringify(schema));
+        if (p.schema.properties) {
+            Object.assign(p.schema.properties, ss.properties);
+        }
+        else {
+            p.schema = JSON.parse(JSON.stringify(schema));
+        }
+        return p;
+    }
     /**
      * 提取参数
      * @param params
@@ -360,6 +385,9 @@ let SwaggerExplorer = class SwaggerExplorer {
             const param = paramMeta.metadata;
             if (param) {
                 p.description = param.description;
+                if (!p.name && param.name) {
+                    p.name = param.name;
+                }
                 if (param.in === 'query') {
                     p.allowEmptyValue = param.allowEmptyValue || false;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.0.4-beta.1",
+  "version": "3.0.7",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,11 +9,11 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.4-beta.1",
-    "@midwayjs/decorator": "^3.0.4-beta.1",
-    "@midwayjs/koa": "^3.0.4-beta.1",
-    "@midwayjs/mock": "^3.0.4-beta.1",
-    "swagger-ui-dist": "4.4.0"
+    "@midwayjs/core": "^3.0.7",
+    "@midwayjs/decorator": "^3.0.7",
+    "@midwayjs/koa": "^3.0.7",
+    "@midwayjs/mock": "^3.0.7",
+    "swagger-ui-dist": "4.5.0"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "52bc37e7a570806c121b33a0e8ac1cd084445f5d"
+  "gitHead": "4ba1e30c46c231abd4188d358f7c9683c9591c54"
 }