@midwayjs/swagger 4.0.0-beta.15 → 4.0.0-beta.17

package/dist/swaggerExplorer.d.ts

@@ -15,6 +15,13 @@ export declare class SwaggerExplorer {
      * 构造 router 提取方法
      */
     private generateRouteMethod;
+    private upsertOperationParameter;
+    private cloneOpenAPIValue;
+    private normalizeContentSchemas;
+    private normalizeOperationParameters;
+    private normalizeOperationRequestBody;
+    private normalizeOperationResponse;
+    private normalizeOperationResponses;
     getOperationId(controllerKey: string, webRouter: RouterOption): string;
     /**
      * 解析 ApiExtraModel

package/dist/swaggerExplorer.js

@@ -268,13 +268,19 @@ let SwaggerExplorer = class SwaggerExplorer {
         if (!opts) {
             opts = {};
         }
-        const parameters = [];
+        const operationParameters = this.normalizeOperationParameters(operMeta?.metadata?.parameters);
+        const operationRequestBody = this.normalizeOperationRequestBody(operMeta?.metadata?.requestBody);
+        const operationResponses = this.normalizeOperationResponses(operMeta?.metadata?.responses);
+        const parameters = [...operationParameters];
+        let requestBodyFromOperation = !!operationRequestBody;
         opts[webRouter.requestMethod] = {
             summary: getNotEmptyValue(operMeta?.metadata?.summary, webRouter.summary),
             description: getNotEmptyValue(operMeta?.metadata?.description, webRouter.description),
             operationId: operMeta?.metadata?.operationId ||
                 this.getOperationId(target.name, webRouter),
             tags: routerTags.length ? routerTags : (operMeta?.metadata?.tags ?? []),
+            ...(operationRequestBody ? { requestBody: operationRequestBody } : {}),
+            ...(operationResponses ? { responses: operationResponses } : {}),
         };
         if (operMeta?.metadata?.deprecated != null) {
             opts[webRouter.requestMethod].deprecated =
@@ -320,7 +326,7 @@ let SwaggerExplorer = class SwaggerExplorer {
             const p = param.metadata;
             p.schema = this.formatType(param.metadata.schema);
             if (p.in === 'query' || p.in === 'path' || p.in === 'header') {
-                parameters.push(p);
+                this.upsertOperationParameter(parameters, p);
             }
             else if (p.in === 'body') {
                 p.content = p.content ?? {};
@@ -336,13 +342,28 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // if requestBody is already set, skip
                 opts[webRouter.requestMethod].requestBody =
                     opts[webRouter.requestMethod].requestBody ?? {};
-                opts[webRouter.requestMethod].requestBody.description =
-                    opts[webRouter.requestMethod].requestBody.description ??
-                        p.description;
-                opts[webRouter.requestMethod].requestBody.content =
-                    opts[webRouter.requestMethod].requestBody.content ?? p.content;
-                opts[webRouter.requestMethod].requestBody.required =
-                    opts[webRouter.requestMethod].requestBody.required ?? p.required;
+                if (requestBodyFromOperation) {
+                    if (p.description !== undefined) {
+                        opts[webRouter.requestMethod].requestBody.description =
+                            p.description;
+                    }
+                    if (p.content !== undefined) {
+                        opts[webRouter.requestMethod].requestBody.content = p.content;
+                    }
+                    if (p.required !== undefined) {
+                        opts[webRouter.requestMethod].requestBody.required = p.required;
+                    }
+                    requestBodyFromOperation = false;
+                }
+                else {
+                    opts[webRouter.requestMethod].requestBody.description =
+                        opts[webRouter.requestMethod].requestBody.description ??
+                            p.description;
+                    opts[webRouter.requestMethod].requestBody.content =
+                        opts[webRouter.requestMethod].requestBody.content ?? p.content;
+                    opts[webRouter.requestMethod].requestBody.required =
+                        opts[webRouter.requestMethod].requestBody.required ?? p.required;
+                }
             }
         }
         for (const arg of args) {
@@ -381,7 +402,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                             schema: schema.properties[pName],
                             required: schema.required?.includes(pName) || false,
                         };
-                        parameters.push(pp);
+                        this.upsertOperationParameter(parameters, pp);
                     });
                     continue;
                 }
@@ -465,76 +486,23 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // in body 不需要处理
                 continue;
             }
-            parameters.push(p);
+            this.upsertOperationParameter(parameters, p);
         }
         // class header 需要使用 ApiHeader 装饰器
         if (headers && headers.length) {
-            headers.forEach(header => parameters.unshift(header));
+            headers.forEach(header => this.upsertOperationParameter(parameters, header, true));
         }
         // 获取方法上的 @ApiHeader
         const methodHeaders = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_HEADERS);
         if (methodHeaders.length > 0) {
-            methodHeaders.forEach(item => parameters.unshift(item.metadata));
+            methodHeaders.forEach(item => this.upsertOperationParameter(parameters, item.metadata, true));
         }
         opts[webRouter.requestMethod].parameters = parameters;
         const responses = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_RESPONSE &&
             item.propertyName === webRouter.method);
-        const returnResponses = {};
+        const returnResponses = operationResponses ?? {};
         for (const r of responses) {
-            const resp = r.metadata;
-            const keys = Object.keys(resp);
-            for (const k of keys) {
-                // 这里是引用，赋值可以直接更改
-                const tt = resp[k];
-                if (tt.schema) {
-                    // response 的 schema 需要包含在 content 内
-                    tt.content = {
-                        'application/json': {
-                            schema: this.formatType(tt.schema),
-                        },
-                    };
-                    delete tt.schema;
-                }
-                else if (tt.type) {
-                    if (core_1.Types.isClass(tt.type)) {
-                        this.parseClzz(tt.type);
-                        if (tt.isArray) {
-                            tt.content = {
-                                'application/json': {
-                                    schema: {
-                                        type: 'array',
-                                        items: {
-                                            $ref: '#/components/schemas/' + tt.type.name,
-                                        },
-                                    },
-                                },
-                            };
-                        }
-                        else {
-                            tt.content = {
-                                'application/json': {
-                                    schema: {
-                                        $ref: '#/components/schemas/' + tt.type.name,
-                                    },
-                                },
-                            };
-                        }
-                    }
-                    else {
-                        tt.content = {
-                            'text/plain': {
-                                schema: {
-                                    type: convertSchemaType(tt.type),
-                                },
-                            },
-                        };
-                    }
-                }
-                delete tt.status;
-                delete tt.type;
-                delete tt.isArray;
-                delete tt.format;
-            }
+            const resp = this.normalizeOperationResponses(r.metadata);
             Object.assign(returnResponses, resp);
         }
         if (Object.keys(returnResponses).length > 0) {
@@ -549,6 +517,133 @@ let SwaggerExplorer = class SwaggerExplorer {
         }
         paths[url] = opts;
     }
+    upsertOperationParameter(parameters, parameter, prepend = false) {
+        const index = parameters.findIndex(item => {
+            return item?.name === parameter?.name && item?.in === parameter?.in;
+        });
+        if (index >= 0) {
+            parameters.splice(index, 1);
+        }
+        if (prepend) {
+            parameters.unshift(parameter);
+        }
+        else {
+            parameters.push(parameter);
+        }
+    }
+    cloneOpenAPIValue(value) {
+        if (Array.isArray(value)) {
+            return value.map(item => this.cloneOpenAPIValue(item));
+        }
+        if (value && typeof value === 'object') {
+            const cloned = {};
+            for (const key in value) {
+                cloned[key] = this.cloneOpenAPIValue(value[key]);
+            }
+            return cloned;
+        }
+        return value;
+    }
+    normalizeContentSchemas(content) {
+        if (!content) {
+            return content;
+        }
+        for (const key in content) {
+            if (content[key]?.schema) {
+                content[key].schema = this.formatType(content[key].schema);
+            }
+        }
+        return content;
+    }
+    normalizeOperationParameters(parameters) {
+        if (!Array.isArray(parameters)) {
+            return [];
+        }
+        return parameters.map(parameter => {
+            const normalized = this.cloneOpenAPIValue(parameter);
+            if (normalized?.schema) {
+                normalized.schema = this.formatType(normalized.schema);
+            }
+            if (normalized.content) {
+                normalized.content = this.normalizeContentSchemas(normalized.content);
+            }
+            return normalized;
+        });
+    }
+    normalizeOperationRequestBody(requestBody) {
+        if (!requestBody) {
+            return undefined;
+        }
+        const normalized = this.cloneOpenAPIValue(requestBody);
+        if (normalized.content) {
+            normalized.content = this.normalizeContentSchemas(normalized.content);
+        }
+        return normalized;
+    }
+    normalizeOperationResponse(response) {
+        const normalized = this.cloneOpenAPIValue(response);
+        if (normalized.schema) {
+            normalized.content = {
+                'application/json': {
+                    schema: this.formatType(normalized.schema),
+                },
+            };
+            delete normalized.schema;
+        }
+        else if (normalized.type) {
+            if (core_1.Types.isClass(normalized.type)) {
+                this.parseClzz(normalized.type);
+                if (normalized.isArray) {
+                    normalized.content = {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/schemas/' + normalized.type.name,
+                                },
+                            },
+                        },
+                    };
+                }
+                else {
+                    normalized.content = {
+                        'application/json': {
+                            schema: {
+                                $ref: '#/components/schemas/' + normalized.type.name,
+                            },
+                        },
+                    };
+                }
+            }
+            else {
+                normalized.content = {
+                    'text/plain': {
+                        schema: {
+                            type: convertSchemaType(normalized.type),
+                        },
+                    },
+                };
+            }
+        }
+        else if (normalized.content) {
+            normalized.content = this.normalizeContentSchemas(normalized.content);
+        }
+        delete normalized.status;
+        delete normalized.type;
+        delete normalized.isArray;
+        delete normalized.format;
+        return normalized;
+    }
+    normalizeOperationResponses(responses) {
+        if (!responses) {
+            return undefined;
+        }
+        const normalizedResponses = this.cloneOpenAPIValue(responses);
+        for (const status in normalizedResponses) {
+            normalizedResponses[status] = this.normalizeOperationResponse(normalizedResponses[status]);
+        }
+        return normalizedResponses;
+    }
     getOperationId(controllerKey, webRouter) {
         return this.operationIdFactory(controllerKey, webRouter);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "4.0.0-beta.15",
+  "version": "4.0.0-beta.17",
   "description": "Midway Component for Swagger API Documentation",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -12,10 +12,10 @@
   ],
   "devDependencies": {
     "@apidevtools/swagger-parser": "11.0.1",
-    "@midwayjs/core": "^4.0.0-beta.15",
-    "@midwayjs/koa": "^4.0.0-beta.15",
-    "@midwayjs/mock": "^4.0.0-beta.15",
-    "@midwayjs/validate": "^4.0.0-beta.15",
+    "@midwayjs/core": "^4.0.0-beta.17",
+    "@midwayjs/koa": "^4.0.0-beta.17",
+    "@midwayjs/mock": "^4.0.0-beta.17",
+    "@midwayjs/validate": "^4.0.0-beta.17",
     "swagger-ui-dist": "5.18.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -30,5 +30,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "e9b3c1672326bc22fe8658ccbe8afd58b9d75d53"
+  "gitHead": "6a20a4fc8c3ddb71dd89f55cf600c34fd817c628"
 }