@midwayjs/swagger 3.0.0-beta.14 → 3.0.0-beta.15

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.15](https://github.com/midwayjs/midway/compare/v3.0.0-beta.14...v3.0.0-beta.15) (2022-01-07)
+
+
+### Features
+
+* compatible with @File/@Files/@Fields ([#1527](https://github.com/midwayjs/midway/issues/1527)) ([3fe983f](https://github.com/midwayjs/midway/commit/3fe983f2a67c366af370c41df98510adf5dab289))
+
+
+
+
+
 # [3.0.0-beta.14](https://github.com/midwayjs/midway/compare/v3.0.0-beta.13...v3.0.0-beta.14) (2022-01-04)
 
 **Note:** Version bump only for package @midwayjs/swagger

package/dist/documentBuilder.d.ts

@@ -12,6 +12,7 @@ export declare class DocumentBuilder {
     setBasePath(path: string | string[]): this;
     addPaths(paths: Record<string, PathItemObject>): this;
     addSchema(schema: Record<string, SchemaObject>): this;
+    getSchema(name: string): SchemaObject;
     addTag(name: string, description?: string, externalDocs?: ExternalDocumentationObject): this;
     addSecurity(name: string, options: SecuritySchemeObject): this;
     addSecurityRequirements(name: string | SecurityRequirementObject, requirements?: string[]): this;

package/dist/documentBuilder.js

@@ -77,6 +77,9 @@ class DocumentBuilder {
         Object.assign(this.document.components.schemas, schema);
         return this;
     }
+    getSchema(name) {
+        return this.document.components.schemas[name];
+    }
     addTag(name, description = '', externalDocs) {
         if (Array.isArray(name)) {
             const arr = name;

package/dist/swaggerExplorer.js

@@ -13,12 +13,13 @@ exports.SwaggerExplorer = void 0;
 const decorator_1 = require("@midwayjs/decorator");
 const constants_1 = require("./constants");
 const documentBuilder_1 = require("./documentBuilder");
+const _1 = require(".");
 let SwaggerExplorer = class SwaggerExplorer {
     constructor() {
         this.documentBuilder = new documentBuilder_1.DocumentBuilder();
     }
     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, _1, _2, _3, _4;
+        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;
         this.documentBuilder.setTitle(this.swaggerConfig.title);
         this.documentBuilder.setVersion(this.swaggerConfig.version);
         this.documentBuilder.setDescription(this.swaggerConfig.description);
@@ -47,18 +48,18 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
         }
         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)) {
-            for (const t of (_1 = this.swaggerConfig) === null || _1 === void 0 ? void 0 : _1.tags) {
+            for (const t of (_2 = this.swaggerConfig) === null || _2 === void 0 ? void 0 : _2.tags) {
                 this.documentBuilder.addTag(t.name, t.description, t.externalDocs);
             }
         }
         // 设置 auth 类型
-        if (Array.isArray((_2 = this.swaggerConfig) === null || _2 === void 0 ? void 0 : _2.auth)) {
-            for (const a of (_3 = this.swaggerConfig) === null || _3 === void 0 ? void 0 : _3.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) {
                 this.setAuth(a);
             }
         }
         else {
-            this.setAuth((_4 = this.swaggerConfig) === null || _4 === void 0 ? void 0 : _4.auth);
+            this.setAuth((_5 = this.swaggerConfig) === null || _5 === void 0 ? void 0 : _5.auth);
         }
     }
     scanApp() {
@@ -158,7 +159,7 @@ let SwaggerExplorer = class SwaggerExplorer {
      * 构造 router 提取方法
      */
     generateRouteMethod(url, webRouter, paths, metaForMethods, metaForParams, header, target) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        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];
@@ -209,18 +210,63 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
             this.parseFromParamsToP(params[params.length - 1 - arg.parameterIndex], p);
             if (p.in === 'body') {
+                // 这里兼容一下 @File()、@Files()、@Fields() 装饰器
+                if (((_j = arg.metadata) === null || _j === void 0 ? void 0 : _j.type) === decorator_1.RouteParamTypes.FILESSTREAM) {
+                    p.schema = {
+                        properties: {
+                            files: {
+                                type: 'array',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                                description: p.description,
+                            },
+                        },
+                    };
+                    p.contentType = _1.BodyContentType.Multipart;
+                }
+                if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === decorator_1.RouteParamTypes.FILESTREAM) {
+                    p.schema = {
+                        properties: {
+                            file: {
+                                type: 'string',
+                                format: 'binary',
+                                description: p.description,
+                            },
+                        },
+                    };
+                    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));
+                    }
+                    p.contentType = _1.BodyContentType.Multipart;
+                }
                 if (!p.content) {
                     p.content = {};
                     p.content[p.contentType || 'application/json'] = {
                         schema: p.schema,
                     };
                 }
-                const requestBody = {
-                    required: true,
-                    description: p.description || p.name,
-                    content: p.content,
-                };
-                opts[webRouter.requestMethod].requestBody = requestBody;
+                if (!opts[webRouter.requestMethod].requestBody) {
+                    const requestBody = {
+                        required: true,
+                        description: p.description || p.name,
+                        content: p.content,
+                    };
+                    opts[webRouter.requestMethod].requestBody = requestBody;
+                }
+                else {
+                    // 这里拼 schema properties 时肯定存在
+                    Object.assign(opts[webRouter.requestMethod].requestBody.content[p.contentType]
+                        .schema.properties, p.schema.properties);
+                }
                 delete p.contentType;
                 delete p.content;
                 // in body 不需要处理
@@ -579,6 +625,9 @@ function convertTypeToString(type) {
         case decorator_1.RouteParamTypes.PARAM:
             return 'path';
         case decorator_1.RouteParamTypes.BODY:
+        case decorator_1.RouteParamTypes.FIELDS:
+        case decorator_1.RouteParamTypes.FILESSTREAM:
+        case decorator_1.RouteParamTypes.FILESTREAM:
             return 'body';
         default:
             return 'header';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.0.0-beta.14",
+  "version": "3.0.0-beta.15",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,10 +9,10 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.14",
-    "@midwayjs/decorator": "^3.0.0-beta.14",
-    "@midwayjs/koa": "^3.0.0-beta.14",
-    "@midwayjs/mock": "^3.0.0-beta.14",
+    "@midwayjs/core": "^3.0.0-beta.15",
+    "@midwayjs/decorator": "^3.0.0-beta.15",
+    "@midwayjs/koa": "^3.0.0-beta.15",
+    "@midwayjs/mock": "^3.0.0-beta.15",
     "swagger-ui-dist": "4.1.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "95695ada36190cf376e93a1a8866b3fb6dde06bc"
+  "gitHead": "6b9778557289d9e8b562c7ce6127736db1248973"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2013 - Now midwayjs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.