@midwayjs/swagger 3.3.13 → 3.4.0-beta.10

package/README.md

@@ -1,13 +1,10 @@
-# midwayjs swagger module
+# midway swagger module
 
 ## Thanks to [@nestjs/swagger](https://github.com/nestjs/swagger)
 
-[![Package Quality](http://npm.packagequality.com/shield/midway-core.svg)](http://packagequality.com/#?package=midway-core)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
-
 this is a sub package for midway.
 
-Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
+Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 

package/dist/interfaces/index.d.ts

@@ -336,5 +336,24 @@ export interface SwaggerOptions {
      * 可以使用 1-xxx、2-xxx、3-xxx 来定义 tag
      */
     tagSortable?: boolean;
+    /**
+     * UI 展示中需要用到的配置
+     * 可以参考 https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#display
+     */
+    displayOptions?: {
+        deepLinking?: boolean;
+        displayOperationId?: boolean;
+        defaultModelsExpandDepth?: number;
+        defaultModelExpandDepth?: number;
+        defaultModelRendering?: 'example' | 'model';
+        displayRequestDuration?: boolean;
+        docExpansion?: 'list' | 'full' | 'none';
+        filter?: boolean | string;
+        maxDisplayedTags?: number;
+        showExtensions?: boolean;
+        showCommonExtensions?: boolean;
+        useUnsafeMarkdown?: boolean;
+        tryItOutEnabled?: boolean;
+    };
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/swaggerExplorer.js

@@ -381,7 +381,7 @@ let SwaggerExplorer = class SwaggerExplorer {
      * @param p
      */
     parseFromParamsToP(paramMeta, p) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         if (paramMeta) {
             const param = paramMeta.metadata;
             if (param) {
@@ -392,7 +392,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 if (param.in === 'query') {
                     p.allowEmptyValue = param.allowEmptyValue || false;
                 }
-                if (param.example) {
+                if (typeof param.example !== undefined) {
                     p.example = param.example;
                 }
                 if (param.examples) {
@@ -432,13 +432,22 @@ let SwaggerExplorer = class SwaggerExplorer {
                             };
                         }
                         if (param.isArray) {
+                            let ref;
+                            if ((_c = p === null || p === void 0 ? void 0 : p.schema) === null || _c === void 0 ? void 0 : _c.$ref) {
+                                ref = p.schema.$ref;
+                            }
                             p.schema = {
                                 type: 'array',
                                 items: {
-                                    type: (_d = (_c = p === null || p === void 0 ? void 0 : p.schema) === null || _c === void 0 ? void 0 : _c.$ref) !== null && _d !== void 0 ? _d : convertSchemaType(param.type),
                                     format: param.format,
                                 },
                             };
+                            if (ref) {
+                                p.schema.items.$ref = ref;
+                            }
+                            else {
+                                p.schema.items.type = convertSchemaType(param.type);
+                            }
                         }
                         else {
                             if (!p.schema) {
@@ -492,12 +501,11 @@ let SwaggerExplorer = class SwaggerExplorer {
             Object.keys(props).forEach(key => {
                 var _a, _b;
                 const metadata = props[key].metadata;
-                if (metadata === null || metadata === void 0 ? void 0 : metadata.example) {
+                if (typeof (metadata === null || metadata === void 0 ? void 0 : metadata.example) !== undefined) {
                     if (!tt.example) {
                         tt.example = {};
                     }
                     tt.example[key] = metadata === null || metadata === void 0 ? void 0 : metadata.example;
-                    delete metadata.example;
                 }
                 if (typeof (metadata === null || metadata === void 0 ? void 0 : metadata.required) !== undefined) {
                     if (metadata === null || metadata === void 0 ? void 0 : metadata.required) {

package/dist/swaggerMiddleware.js

@@ -103,7 +103,13 @@ let SwaggerMiddleware = class SwaggerMiddleware {
         }
     }
     replaceInfo(content) {
-        return content.replace('"https://petstore.swagger.io/v2/swagger.json",', `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`);
+        let str = `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
+        if (this.swaggerConfig.displayOptions) {
+            Object.keys(this.swaggerConfig.displayOptions).forEach(key => {
+                str += `\n${key}: ${this.swaggerConfig.displayOptions[key]},`;
+            });
+        }
+        return content.replace('"https://petstore.swagger.io/v2/swagger.json",', str);
     }
     static getName() {
         return 'swagger';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.3.13",
+  "version": "3.4.0-beta.10",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,11 +9,12 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.3.5",
-    "@midwayjs/decorator": "^3.3.4",
-    "@midwayjs/koa": "^3.3.6",
-    "@midwayjs/mock": "^3.3.5",
-    "swagger-ui-dist": "4.6.2"
+    "@midwayjs/core": "^3.4.0-beta.10",
+    "@midwayjs/decorator": "^3.4.0-beta.10",
+    "@midwayjs/koa": "^3.4.0-beta.10",
+    "@midwayjs/mock": "^3.4.0-beta.10",
+    "@midwayjs/validate": "^3.4.0-beta.10",
+    "swagger-ui-dist": "4.12.0"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -27,5 +28,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "bd3b724f3902522d58c6cc3eddfd515a450c62cc"
+  "gitHead": "560a5fa311605e4008c55f31c31bc4e12eeff2a5"
 }