@midwayjs/swagger 3.0.4 → 3.0.8

package/dist/swaggerExplorer.d.ts

@@ -10,6 +10,7 @@ export declare class SwaggerExplorer {
      * 构造 router 提取方法
      */
     private generateRouteMethod;
+    private expandSchemaRef;
     /**
      * 提取参数
      * @param params

package/dist/swaggerExplorer.js

@@ -177,7 +177,7 @@ let SwaggerExplorer = class SwaggerExplorer {
      * 构造 router 提取方法
      */
     generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, header, target) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        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];
@@ -188,8 +188,8 @@ 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}},
@@ -203,8 +203,8 @@ let SwaggerExplorer = class SwaggerExplorer {
         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') {
@@ -221,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: {
@@ -243,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: {
@@ -256,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) {
@@ -360,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
@@ -371,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",
+  "version": "3.0.8",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,10 +9,10 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.4",
-    "@midwayjs/decorator": "^3.0.4",
-    "@midwayjs/koa": "^3.0.4",
-    "@midwayjs/mock": "^3.0.4",
+    "@midwayjs/core": "^3.0.7",
+    "@midwayjs/decorator": "^3.0.7",
+    "@midwayjs/koa": "^3.0.8",
+    "@midwayjs/mock": "^3.0.7",
     "swagger-ui-dist": "4.5.0"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "c2a37dd026c7bf3e855f4498691f572ef61396e3"
+  "gitHead": "5e58d30e217ef06096cebf588e19b8ce020a3d96"
 }