@midwayjs/swagger 3.2.0 → 3.3.0

package/dist/constants.d.ts

@@ -6,6 +6,7 @@ export declare const DECORATORS: {
     API_PARAMETERS: string;
     API_HEADERS: string;
     API_MODEL_PROPERTIES: string;
+    API_EXTRA_MODEL: string;
     API_MODEL_PROPERTIES_ARRAY: string;
     API_SECURITY: string;
     API_EXCLUDE_ENDPOINT: string;

package/dist/constants.js

@@ -9,6 +9,7 @@ exports.DECORATORS = {
     API_PARAMETERS: `${exports.DECORATORS_PREFIX}/apiParameters`,
     API_HEADERS: `${exports.DECORATORS_PREFIX}/apiHeaders`,
     API_MODEL_PROPERTIES: `${exports.DECORATORS_PREFIX}/apiModelProperties`,
+    API_EXTRA_MODEL: `${exports.DECORATORS_PREFIX}/apiExtraModel`,
     API_MODEL_PROPERTIES_ARRAY: `${exports.DECORATORS_PREFIX}/apiModelPropertiesArray`,
     API_SECURITY: `${exports.DECORATORS_PREFIX}/apiSecurity`,
     API_EXCLUDE_ENDPOINT: `${exports.DECORATORS_PREFIX}/apiExcludeEndpoint`,

package/dist/decorators/api-extra-model.decorator.d.ts

@@ -0,0 +1,3 @@
+import { Type } from '../interfaces';
+export declare function ApiExtraModel(models: Type | Type[]): any;
+//# sourceMappingURL=api-extra-model.decorator.d.ts.map

package/dist/decorators/api-extra-model.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExtraModel = void 0;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiExtraModel(models) {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXTRA_MODEL, models);
+}
+exports.ApiExtraModel = ApiExtraModel;
+//# sourceMappingURL=api-extra-model.decorator.js.map

package/dist/decorators/index.d.ts

@@ -14,5 +14,6 @@ export * from './api-bearer.decorator';
 export * from './api-cookie.decorator';
 export * from './api-oauth2.decorator';
 export * from './api-security.decorator';
+export * from './api-extra-model.decorator';
 export { getSchemaPath } from './helpers';
 //# sourceMappingURL=index.d.ts.map

package/dist/decorators/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./api-bearer.decorator"), exports);
 __exportStar(require("./api-cookie.decorator"), exports);
 __exportStar(require("./api-oauth2.decorator"), exports);
 __exportStar(require("./api-security.decorator"), exports);
+__exportStar(require("./api-extra-model.decorator"), exports);
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "getSchemaPath", { enumerable: true, get: function () { return helpers_1.getSchemaPath; } });
 //# sourceMappingURL=index.js.map

package/dist/swaggerExplorer.d.ts

@@ -17,6 +17,11 @@ export declare class SwaggerExplorer {
      * @param p
      */
     private parseFromParamsToP;
+    /**
+     * 解析 ApiExtraModel
+     * @param clzz
+     */
+    private parseExtraModel;
     /**
      * 解析类型的 ApiProperty
      * @param clzz

package/dist/swaggerExplorer.js

@@ -79,6 +79,7 @@ let SwaggerExplorer = class SwaggerExplorer {
         return this.documentBuilder.build();
     }
     generatePath(target) {
+        this.parseExtraModel(target);
         const metaForMethods = (0, decorator_1.getClassMetadata)(decorator_1.INJECT_CUSTOM_METHOD, target) || [];
         const exs = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXCLUDE_CONTROLLER);
         if (exs[0]) {
@@ -455,6 +456,24 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
         }
     }
+    /**
+     * 解析 ApiExtraModel
+     * @param clzz
+     */
+    parseExtraModel(clzz) {
+        const metaForMethods = (0, decorator_1.getClassMetadata)(decorator_1.INJECT_CUSTOM_METHOD, clzz) || [];
+        const extraModels = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXTRA_MODEL);
+        for (const m of extraModels) {
+            if (Array.isArray(m.metadata)) {
+                for (const sclz of m.metadata) {
+                    this.parseClzz(sclz);
+                }
+            }
+            else {
+                this.parseClzz(m.metadata);
+            }
+        }
+    }
     /**
      * 解析类型的 ApiProperty
      * @param clzz
@@ -463,6 +482,7 @@ let SwaggerExplorer = class SwaggerExplorer {
         if (this.documentBuilder.getSchema(clzz.name)) {
             return;
         }
+        this.parseExtraModel(clzz);
         const props = (0, decorator_1.getClassMetadata)(decorator_1.INJECT_CUSTOM_PROPERTY, clzz);
         const tt = {
             type: 'object',
@@ -479,11 +499,13 @@ let SwaggerExplorer = class SwaggerExplorer {
                     tt.example[key] = metadata === null || metadata === void 0 ? void 0 : metadata.example;
                     delete metadata.example;
                 }
-                if ((metadata === null || metadata === void 0 ? void 0 : metadata.required) !== false) {
-                    if (!tt.required) {
-                        tt.required = [];
+                if (typeof (metadata === null || metadata === void 0 ? void 0 : metadata.required) !== undefined) {
+                    if (metadata === null || metadata === void 0 ? void 0 : metadata.required) {
+                        if (!tt.required) {
+                            tt.required = [];
+                        }
+                        tt.required.push(key);
                     }
-                    tt.required.push(key);
                     delete metadata.required;
                 }
                 if (metadata === null || metadata === void 0 ? void 0 : metadata.enum) {
@@ -514,7 +536,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 if (currentType === 'array') {
                     isArray = true;
                     currentType = (_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type;
-                    delete metadata.items;
+                    metadata === null || metadata === void 0 ? true : delete metadata.items.type;
                 }
                 if (decorator_1.Types.isClass(currentType)) {
                     this.parseClzz(currentType);
@@ -534,12 +556,22 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 else {
                     if (isArray) {
-                        tt.properties[key] = {
-                            type: 'array',
-                            items: {
-                                type: convertSchemaType((currentType === null || currentType === void 0 ? void 0 : currentType.name) || currentType),
-                            },
-                        };
+                        // 没有配置类型则认为自己配置了 items 内容
+                        if (!currentType) {
+                            tt.properties[key] = {
+                                type: 'array',
+                                items: metadata === null || metadata === void 0 ? void 0 : metadata.items,
+                            };
+                            delete metadata.items;
+                        }
+                        else {
+                            tt.properties[key] = {
+                                type: 'array',
+                                items: {
+                                    type: convertSchemaType((currentType === null || currentType === void 0 ? void 0 : currentType.name) || currentType),
+                                },
+                            };
+                        }
                     }
                     else {
                         tt.properties[key] = {

package/dist/swaggerMiddleware.js

@@ -42,7 +42,8 @@ let SwaggerMiddleware = class SwaggerMiddleware {
                 let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName), {
                     encoding: 'utf-8',
                 });
-                if (lastName === 'index.html') {
+                if (lastName === 'index.html' ||
+                    lastName === 'swagger-initializer.js') {
                     content = this.replaceInfo(content);
                 }
                 const ext = (0, path_1.extname)(lastName);
@@ -80,7 +81,8 @@ let SwaggerMiddleware = class SwaggerMiddleware {
                 let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName), {
                     encoding: 'utf-8',
                 });
-                if (lastName === 'index.html') {
+                if (lastName === 'index.html' ||
+                    lastName === 'swagger-initializer.js') {
                     content = this.replaceInfo(content);
                 }
                 const ext = (0, path_1.extname)(lastName);

package/index.d.ts

@@ -1,7 +1,7 @@
 import { SwaggerOptions } from './dist/index';
 export * from './dist/index';
 
-declare module '@midwayjs/core' {
+declare module '@midwayjs/core/dist/interface' {
   interface MidwayConfig {
     swagger?: Partial<SwaggerOptions>;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,10 +9,10 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.2.0",
+    "@midwayjs/core": "^3.3.0",
     "@midwayjs/decorator": "^3.1.6",
-    "@midwayjs/koa": "^3.2.0",
-    "@midwayjs/mock": "^3.2.0",
+    "@midwayjs/koa": "^3.3.0",
+    "@midwayjs/mock": "^3.3.0",
     "swagger-ui-dist": "4.6.2"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "cee3e5ddbb4f0cc5f80176a7b1e271e809686a97"
+  "gitHead": "b12b41188879296f9863265baa5bbdb4158bddc5"
 }