@midwayjs/swagger 3.11.12 → 3.11.16

package/dist/interfaces/index.d.ts

@@ -2,6 +2,7 @@
  * inspired by https://github.com/metadevpro/openapi3-ts
  * @see https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md
  */
+import type { RouterOption } from '@midwayjs/core';
 export interface OpenAPIObject {
     openapi: string;
     info: InfoObject;
@@ -355,5 +356,12 @@ export interface SwaggerOptions {
         useUnsafeMarkdown?: boolean;
         tryItOutEnabled?: boolean;
     };
+    documentOptions?: {
+        /**
+         * 自定义 operationIdFactory，用于生成 operationId
+         * @default () => controllerKey_webRouter.methodKey
+         */
+        operationIdFactory?: (controllerKey: string, webRouter: RouterOption) => string;
+    };
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/swaggerExplorer.d.ts

@@ -1,7 +1,9 @@
+import { RouterOption } from '@midwayjs/core';
 import { Type } from './interfaces';
 export declare class SwaggerExplorer {
     private swaggerConfig;
     private documentBuilder;
+    private operationIdFactory;
     init(): Promise<void>;
     addGlobalPrefix(prefix: string): void;
     scanApp(): void;
@@ -11,6 +13,7 @@ export declare class SwaggerExplorer {
      * 构造 router 提取方法
      */
     private generateRouteMethod;
+    getOperationId(controllerKey: string, webRouter: RouterOption): string;
     private expandSchemaRef;
     /**
      * 提取参数

package/dist/swaggerExplorer.js

@@ -17,9 +17,10 @@ const _1 = require(".");
 let SwaggerExplorer = class SwaggerExplorer {
     constructor() {
         this.documentBuilder = new documentBuilder_1.DocumentBuilder();
+        this.operationIdFactory = (controllerKey, webRouter) => `${controllerKey.toLowerCase()}_${webRouter.method.toLocaleLowerCase()}`;
     }
     async init() {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _2, _3, _4, _5;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _2, _3, _4, _5, _6, _7;
         this.documentBuilder.setTitle(this.swaggerConfig.title);
         this.documentBuilder.setVersion(this.swaggerConfig.version);
         this.documentBuilder.setDescription(this.swaggerConfig.description);
@@ -49,14 +50,18 @@ let SwaggerExplorer = class SwaggerExplorer {
                 this.documentBuilder.addTag(t.name, t.description, t.externalDocs);
             }
         }
+        if ((_4 = (_3 = this.swaggerConfig) === null || _3 === void 0 ? void 0 : _3.documentOptions) === null || _4 === void 0 ? void 0 : _4.operationIdFactory) {
+            this.operationIdFactory =
+                this.swaggerConfig.documentOptions.operationIdFactory;
+        }
         // 设置 auth 类型
-        if (Array.isArray((_3 = this.swaggerConfig) === null || _3 === void 0 ? void 0 : _3.auth)) {
-            for (const a of (_4 = this.swaggerConfig) === null || _4 === void 0 ? void 0 : _4.auth) {
+        if (Array.isArray((_5 = this.swaggerConfig) === null || _5 === void 0 ? void 0 : _5.auth)) {
+            for (const a of (_6 = this.swaggerConfig) === null || _6 === void 0 ? void 0 : _6.auth) {
                 this.setAuth(a);
             }
         }
         else {
-            this.setAuth((_5 = this.swaggerConfig) === null || _5 === void 0 ? void 0 : _5.auth);
+            this.setAuth((_7 = this.swaggerConfig) === null || _7 === void 0 ? void 0 : _7.auth);
         }
     }
     addGlobalPrefix(prefix) {
@@ -119,10 +124,9 @@ let SwaggerExplorer = class SwaggerExplorer {
         // const globalMiddleware = controllerOption.routerOptions.middleware;
         // get router info
         const webRouterInfo = (0, core_1.getClassMetadata)(core_1.WEB_ROUTER_KEY, target);
-        let header = null;
-        const headers = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_HEADERS);
+        let headers = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_HEADERS);
         if (headers.length > 0) {
-            header = headers[0].metadata;
+            headers = headers.map(item => item.metadata);
         }
         const security = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_SECURITY);
         const paths = {};
@@ -146,7 +150,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     // swagger not support more than one @Body
                     continue;
                 }
-                this.generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, header, target);
+                this.generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, headers, target);
                 // 这里赋值 tags
                 if (paths[url][webRouter.requestMethod].tags.length === 0) {
                     paths[url][webRouter.requestMethod].tags = strTags;
@@ -177,8 +181,8 @@ let SwaggerExplorer = class SwaggerExplorer {
     /**
      * 构造 router 提取方法
      */
-    generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, header, target) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, headers, target) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         const operMeta = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_OPERATION &&
             item.propertyName === webRouter.method)[0];
         let opts = paths[url];
@@ -189,7 +193,7 @@ let SwaggerExplorer = class SwaggerExplorer {
         opts[webRouter.requestMethod] = {
             summary: getNotEmptyValue((_a = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _a === void 0 ? void 0 : _a.summary, webRouter.summary),
             description: getNotEmptyValue((_b = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _b === void 0 ? void 0 : _b.description, webRouter.description),
-            // operationId: `${webRouter.requestMethod}_${(operMeta?.metadata?.operationId || webRouter.method)}`,
+            operationId: this.getOperationId(target.name, webRouter),
             tags: ((_c = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _c === void 0 ? void 0 : _c.tags) || [],
         };
         /**
@@ -296,8 +300,8 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 else {
                     // 这里拼 schema properties 时肯定存在
-                    Object.assign(opts[webRouter.requestMethod].requestBody.content[p.contentType]
-                        .schema.properties, p.schema.properties);
+                    Object.assign({}, (_l = opts[webRouter.requestMethod].requestBody.content[p.contentType]
+                        .schema) === null || _l === void 0 ? void 0 : _l.properties, p.schema.properties);
                 }
                 delete p.contentType;
                 delete p.content;
@@ -307,8 +311,8 @@ let SwaggerExplorer = class SwaggerExplorer {
             parameters.push(p);
         }
         // class header 需要使用 ApiHeader 装饰器
-        if (header) {
-            parameters.unshift(header);
+        if (headers) {
+            headers.forEach(header => parameters.unshift(header));
         }
         opts[webRouter.requestMethod].parameters = parameters;
         const responses = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_RESPONSE &&
@@ -374,6 +378,9 @@ let SwaggerExplorer = class SwaggerExplorer {
         }
         paths[url] = opts;
     }
+    getOperationId(controllerKey, webRouter) {
+        return this.operationIdFactory(controllerKey, webRouter);
+    }
     expandSchemaRef(p, name) {
         let schemaName = name;
         if (p.schema['$ref']) {
@@ -381,13 +388,15 @@ let SwaggerExplorer = class SwaggerExplorer {
             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));
+        if (schemaName) {
+            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;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.11.12",
+  "version": "3.11.16",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,10 +9,10 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.11.11",
-    "@midwayjs/koa": "^3.11.12",
-    "@midwayjs/mock": "^3.11.12",
-    "@midwayjs/validate": "^3.11.12",
+    "@midwayjs/core": "^3.11.15",
+    "@midwayjs/koa": "^3.11.15",
+    "@midwayjs/mock": "^3.11.15",
+    "@midwayjs/validate": "^3.11.15",
     "swagger-ui-dist": "4.19.1"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "7454a59cd57e693a04e4c887535c9193354e2980"
+  "gitHead": "ae8b35ec53d10f9c3b19bb74a9f0b235dcf5b030"
 }