@midwayjs/swagger 3.0.0-beta.13 → 3.0.0-beta.17

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;
@@ -20,6 +21,7 @@ export declare class DocumentBuilder {
     addApiKey(options?: SecuritySchemeObject, name?: string): this;
     addBasicAuth(options?: SecuritySchemeObject, name?: string): this;
     addCookieAuth(cookieName?: string, options?: SecuritySchemeObject, securityName?: string): this;
+    sortTags(): void;
     build(): Omit<OpenAPIObject, 'paths'>;
 }
 //# sourceMappingURL=documentBuilder.d.ts.map

package/dist/documentBuilder.js

@@ -77,6 +77,13 @@ class DocumentBuilder {
         Object.assign(this.document.components.schemas, schema);
         return this;
     }
+    getSchema(name) {
+        var _a, _b;
+        if ((_a = this.document.components) === null || _a === void 0 ? void 0 : _a.schemas) {
+            return (_b = this.document.components) === null || _b === void 0 ? void 0 : _b.schemas[name];
+        }
+        return undefined;
+    }
     addTag(name, description = '', externalDocs) {
         if (Array.isArray(name)) {
             const arr = name;
@@ -184,6 +191,23 @@ class DocumentBuilder {
         });
         return this;
     }
+    sortTags() {
+        const tags = this.document.tags;
+        this.document.tags = tags.sort((a, b) => {
+            const s1 = a.name;
+            const s2 = b.name;
+            const len = s1.length > s2.length ? s2.length : s1.length;
+            for (let i = 0; i < len; i++) {
+                if (s1.charCodeAt(i) > s2.charCodeAt(i)) {
+                    return 1;
+                }
+                else if (s1.charCodeAt(i) < s2.charCodeAt(i)) {
+                    return -1;
+                }
+            }
+            return 0;
+        });
+    }
     build() {
         return this.document;
     }

package/dist/interfaces/index.d.ts

@@ -335,5 +335,10 @@ export interface SwaggerOptions {
      * 访问 swagger ui 的路径
      */
     swaggerPath?: string;
+    /**
+     * 对路由 tag 进行 ascii 排序
+     * 可以使用 1-xxx、2-xxx、3-xxx 来定义 tag
+     */
+    tagSortable?: boolean;
 }
 //# sourceMappingURL=index.d.ts.map

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,25 +48,29 @@ 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() {
+        var _a;
         const routes = (0, decorator_1.listModule)(decorator_1.CONTROLLER_KEY);
         for (const route of routes) {
             this.generatePath(route);
         }
+        if ((_a = this.swaggerConfig) === null || _a === void 0 ? void 0 : _a.tagSortable) {
+            this.documentBuilder.sortTags();
+        }
     }
     getData() {
         return this.documentBuilder.build();
@@ -98,11 +103,12 @@ let SwaggerExplorer = class SwaggerExplorer {
                     (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.description) || tag.name;
             }
             else {
-                tag.name = (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.tagName) || 'default';
+                tag.name = controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.tagName;
                 tag.description =
                     (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.description) || tag.name;
             }
             if (tag.name) {
+                strTags.push(tag.name);
                 this.documentBuilder.addTag(tag.name, tag.description);
             }
         }
@@ -158,7 +164,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];
@@ -196,7 +202,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     continue;
                 }
             }
-            if ((0, decorator_1.isClass)(currentType)) {
+            if (decorator_1.Types.isClass(currentType)) {
                 this.parseClzz(currentType);
                 p.schema = {
                     $ref: '#/components/schemas/' + currentType.name,
@@ -209,18 +215,65 @@ 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 = {
+                        type: 'object',
+                        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 = {
+                        type: 'object',
+                        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 不需要处理
@@ -243,7 +296,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // 这里是引用，赋值可以直接更改
                 const tt = resp[k];
                 if (tt.type) {
-                    if ((0, decorator_1.isClass)(tt.type)) {
+                    if (decorator_1.Types.isClass(tt.type)) {
                         this.parseClzz(tt.type);
                         if (tt.isArray) {
                             tt.content = {
@@ -343,7 +396,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 else {
                     if (param.type) {
-                        if ((0, decorator_1.isClass)(param.type)) {
+                        if (decorator_1.Types.isClass(param.type)) {
                             this.parseClzz(param.type);
                             p.schema = {
                                 $ref: '#/components/schemas/' + param.type.name,
@@ -379,6 +432,9 @@ let SwaggerExplorer = class SwaggerExplorer {
      * @param clzz
      */
     parseClzz(clzz) {
+        if (this.documentBuilder.getSchema(clzz.name)) {
+            return;
+        }
         const props = (0, decorator_1.getClassMetadata)(decorator_1.INJECT_CUSTOM_PROPERTY, clzz);
         const tt = {
             type: 'object',
@@ -432,7 +488,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     currentType = (_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type;
                     delete metadata.items;
                 }
-                if ((0, decorator_1.isClass)(currentType)) {
+                if (decorator_1.Types.isClass(currentType)) {
                     this.parseClzz(currentType);
                     if (isArray) {
                         tt.properties[key] = {
@@ -579,6 +635,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';
@@ -595,7 +654,7 @@ function convertSchemaType(value) {
         case 'String':
             return 'string';
         default:
-            return 'object';
+            return value;
     }
 }
 //# sourceMappingURL=swaggerExplorer.js.map

package/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.0.0-beta.13",
+  "version": "3.0.0-beta.17",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,23 +9,23 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.13",
-    "@midwayjs/decorator": "^3.0.0-beta.13",
-    "@midwayjs/koa": "^3.0.0-beta.13",
-    "@midwayjs/mock": "^3.0.0-beta.13",
-    "swagger-ui-dist": "^3.34.0"
+    "@midwayjs/core": "^3.0.0-beta.17",
+    "@midwayjs/decorator": "^3.0.0-beta.17",
+    "@midwayjs/koa": "^3.0.0-beta.17",
+    "@midwayjs/mock": "^3.0.0-beta.17",
+    "swagger-ui-dist": "4.1.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
     "jest": "node --require=ts-node/register ../../node_modules/jest/bin/jest.js",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit"
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "d3c47770fee9dce33a8d148882173fd7782864ad"
+  "gitHead": "17a8b5bd3d0b0b21f24dd2f165b5df9097fc3ec4"
 }

package/CHANGELOG.md

@@ -1,49 +0,0 @@
-# Change Log
-
-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.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
-
-
-### Features
-
-* add custom decorator filter ([#1477](https://github.com/midwayjs/midway/issues/1477)) ([97501a9](https://github.com/midwayjs/midway/commit/97501a989abc211b0c7400b1df45e050bb237c6a))
-
-
-
-
-
-# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
-
-
-### Bug Fixes
-
-* 3.x copy all properties ([#1444](https://github.com/midwayjs/midway/issues/1444)) ([21ec8b6](https://github.com/midwayjs/midway/commit/21ec8b6a85b6ba3f4fbff0c8a571484aaa078788))
-
-
-### Features
-
-* add fileupload support ([#1439](https://github.com/midwayjs/midway/issues/1439)) ([0a81e72](https://github.com/midwayjs/midway/commit/0a81e720f525ddab0718301f44f80fce376f9bfe))
-* support throw err status ([#1440](https://github.com/midwayjs/midway/issues/1440)) ([7b98110](https://github.com/midwayjs/midway/commit/7b98110d65c5287a8fcb3eb5356dea2d7a32cee9))
-
-
-
-
-
-# [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
-
-**Note:** Version bump only for package @midwayjs/swagger
-
-
-
-
-
-# [3.0.0-beta.10](https://github.com/midwayjs/midway/compare/v3.0.0-beta.9...v3.0.0-beta.10) (2021-12-20)
-
-
-### Features
-
-* 3.x swagger ([#1409](https://github.com/midwayjs/midway/issues/1409)) ([e00fbbf](https://github.com/midwayjs/midway/commit/e00fbbf7a494f300a53f3bd8635966364cfd96a9))
-* add swagger doc & fix bug ([#1427](https://github.com/midwayjs/midway/issues/1427)) ([82dc6f1](https://github.com/midwayjs/midway/commit/82dc6f10f7244a75f58922edda1b0625fc6cb90e))
-* support express ([61e73db](https://github.com/midwayjs/midway/commit/61e73db509bfea21c8251855fccb02a4ce09988f))