@midwayjs/swagger 1.0.5 → 1.2.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.7](https://github.com/midwayjs/midway-component/compare/@midwayjs/swagger@1.0.6...@midwayjs/swagger@1.0.7) (2021-03-22)
+
+
+### Bug Fixes
+
+* [#26](https://github.com/midwayjs/midway-component/issues/26) check the route info is iterable or not ([#27](https://github.com/midwayjs/midway-component/issues/27)) ([f0d4798](https://github.com/midwayjs/midway-component/commit/f0d479832aef0b558bfeac04b32a28cc83192810))
+
+
+
+
+
+## [1.0.6](https://github.com/midwayjs/midway-component/compare/@midwayjs/swagger@1.0.5...@midwayjs/swagger@1.0.6) (2020-12-09)
+
+
+### Bug Fixes
+
+* array type with rule decorator ([#22](https://github.com/midwayjs/midway-component/issues/22)) ([f3b1164](https://github.com/midwayjs/midway-component/commit/f3b1164381b5c02b1d1192acfaf30f01bb34650a))
+
+
+
+
+
 ## [1.0.5](https://github.com/midwayjs/midway-component/compare/@midwayjs/swagger@1.0.4...@midwayjs/swagger@1.0.5) (2020-12-02)
 
 

package/dist/configuration.js

@@ -18,9 +18,9 @@ let AutoConfiguration = class AutoConfiguration {
     }
 };
 AutoConfiguration = __decorate([
-    decorator_1.Configuration({
+    (0, decorator_1.Configuration)({
         namespace: 'swagger',
-        importConfigs: [path_1.join(__dirname, 'config')],
+        importConfigs: [(0, path_1.join)(__dirname, 'config')],
     })
 ], AutoConfiguration);
 exports.AutoConfiguration = AutoConfiguration;

package/dist/controller/swagger.js

@@ -20,8 +20,10 @@ const core_1 = require("@midwayjs/core");
 const generator_1 = require("../service/generator");
 let SwaggerController = class SwaggerController {
     constructor() {
-        const { getAbsoluteFSPath } = core_1.safeRequire('swagger-ui-dist');
-        this.swaggerUiAssetPath = getAbsoluteFSPath();
+        const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
+        if (getAbsoluteFSPath) {
+            this.swaggerUiAssetPath = getAbsoluteFSPath();
+        }
     }
     async renderJSON() {
         return this.swaggerGenerator.generate();
@@ -33,61 +35,61 @@ let SwaggerController = class SwaggerController {
         if (!fileName) {
             fileName = '/index.html';
         }
-        const resourceAbsolutePath = path_1.join(this.swaggerUiAssetPath, fileName);
-        if (path_1.extname(fileName)) {
+        const resourceAbsolutePath = (0, path_1.join)(this.swaggerUiAssetPath, fileName);
+        if ((0, path_1.extname)(fileName)) {
             // 7 天内使用缓存
             if (this.app.getFrameworkType() === core_1.MidwayFrameworkType.WEB_EXPRESS) {
-                this.ctx.res.type(path_1.extname(fileName));
+                this.ctx.res.type((0, path_1.extname)(fileName));
                 this.ctx.res.set('cache-control', 'public, max-age=604800');
             }
             else {
-                this.ctx.type = path_1.extname(fileName);
+                this.ctx.type = (0, path_1.extname)(fileName);
                 this.ctx.set('cache-control', 'public, max-age=604800');
             }
         }
         if (fileName.indexOf('index.html') !== -1) {
             const htmlContent = this.getSwaggerUIResource(resourceAbsolutePath, 'utf-8');
-            return htmlContent.replace('https://petstore.swagger.io/v2/swagger.json', '/swagger-ui/json');
+            return htmlContent.replace('https://petstore.swagger.io/v2/swagger.json', this.ctx.path.replace('/swagger-ui/index.html', '/swagger-ui/json'));
         }
         else {
             return this.getSwaggerUIResource(resourceAbsolutePath);
         }
     }
     getSwaggerUIResource(requestPath, encoding) {
-        return fs_1.readFileSync(requestPath, {
+        return (0, fs_1.readFileSync)(requestPath, {
             encoding,
         });
     }
 };
 __decorate([
-    decorator_1.App(),
+    (0, decorator_1.App)(),
     __metadata("design:type", Object)
 ], SwaggerController.prototype, "app", void 0);
 __decorate([
-    decorator_1.Inject(),
+    (0, decorator_1.Inject)(),
     __metadata("design:type", Object)
 ], SwaggerController.prototype, "ctx", void 0);
 __decorate([
-    decorator_1.Inject(),
+    (0, decorator_1.Inject)(),
     __metadata("design:type", generator_1.SwaggerGenerator)
 ], SwaggerController.prototype, "swaggerGenerator", void 0);
 __decorate([
-    decorator_1.Get('/json'),
+    (0, decorator_1.Get)('/json'),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
 ], SwaggerController.prototype, "renderJSON", null);
 __decorate([
-    decorator_1.Get('/'),
-    decorator_1.Get('/:fileName'),
-    __param(0, decorator_1.Param()),
+    (0, decorator_1.Get)('/'),
+    (0, decorator_1.Get)('/:fileName'),
+    __param(0, (0, decorator_1.Param)()),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
 ], SwaggerController.prototype, "renderSwagger", null);
 SwaggerController = __decorate([
-    decorator_1.Provide(),
-    decorator_1.Controller('/swagger-ui'),
+    (0, decorator_1.Provide)(),
+    (0, decorator_1.Controller)('/swagger-ui'),
     __metadata("design:paramtypes", [])
 ], SwaggerController);
 exports.SwaggerController = SwaggerController;

package/dist/index.js

@@ -7,9 +7,10 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
 var configuration_1 = require("./configuration");
 Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.AutoConfiguration; } });
 __exportStar(require("./controller/swagger"), exports);

package/dist/lib/createAPI.d.ts

@@ -6,12 +6,14 @@ export interface ApiFormat {
     response: APIResponseFormat[];
 }
 export interface APIParamFormat {
-    name: string;
-    description: string;
-    required: boolean;
-    deprecated: boolean;
-    allowEmptyValue: boolean;
-    example: any;
+    name?: string;
+    type?: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    example?: any;
+    $ref?: string;
 }
 export interface APIPropertyFormat {
     description: string;

package/dist/lib/createAPI.js

@@ -61,7 +61,7 @@ class SwaggerAPI {
     }
     build() {
         return (target, property) => {
-            decorator_1.savePropertyMetadata(exports.SWAGGER_DOCUMENT_KEY, this.buildJSON(), target, property);
+            (0, decorator_1.savePropertyMetadata)(exports.SWAGGER_DOCUMENT_KEY, this.buildJSON(), target, property);
         };
     }
 }
@@ -77,8 +77,8 @@ function CreateApiDoc(data) {
 exports.CreateApiDoc = CreateApiDoc;
 function CreateApiPropertyDoc(description, options) {
     return (target, propertyKey) => {
-        const metadata = decorator_1.getPropertyType(target, propertyKey);
-        decorator_1.attachClassMetadata(exports.SWAGGER_DOCUMENT_KEY, {
+        const metadata = (0, decorator_1.getPropertyType)(target, propertyKey);
+        (0, decorator_1.attachClassMetadata)(exports.SWAGGER_DOCUMENT_KEY, {
             description,
             type: metadata.name,
             isBaseType: metadata.isBaseType,

package/dist/lib/document.d.ts

@@ -66,8 +66,8 @@ export declare class SwaggerDocumentRouter {
     consumes: string[];
     produces: string[];
     parameters: SwaggerDocumentParameter[];
-    requestBody: object;
-    responses: object;
+    requestBody: Record<string, unknown>;
+    responses: Record<string, unknown>;
     security: [];
     constructor(method: any, url: any);
     toJSON(): {
@@ -78,8 +78,8 @@ export declare class SwaggerDocumentRouter {
         consumes: string[];
         produces: string[];
         parameters: any;
-        requestBody: object;
-        responses: object;
+        requestBody: Record<string, unknown>;
+        responses: Record<string, unknown>;
     };
 }
 export declare class SwaggerDocumentParameter {

package/dist/lib/generator.d.ts

@@ -26,5 +26,6 @@ export declare class SwaggerMetaGenerator {
     };
     generateRouter(webRouterInfo: RouterOption, swaggerRouter: SwaggerDocumentRouter, module: any): void;
     generateSwaggerDefinition(definitionClass: any): void;
+    generateSwaggerByJoiProperty(joiSchema: any, pathName?: string): any;
 }
 //# sourceMappingURL=generator.d.ts.map

package/dist/lib/generator.js

@@ -18,7 +18,7 @@ class SwaggerMetaGenerator {
         this.document.info = info;
     }
     generateController(module) {
-        const controllerOption = decorator_1.getClassMetadata(decorator_1.CONTROLLER_KEY, module);
+        const controllerOption = (0, decorator_1.getClassMetadata)(decorator_1.CONTROLLER_KEY, module);
         const prefix = controllerOption.prefix;
         const tag = new document_1.SwaggerDocumentTag();
         if (prefix !== '/') {
@@ -34,14 +34,16 @@ class SwaggerMetaGenerator {
         this.document.tags.push(tag);
         // const globalMiddleware = controllerOption.routerOptions.middleware;
         // get router info
-        const webRouterInfo = decorator_1.getClassMetadata(decorator_1.WEB_ROUTER_KEY, module);
-        for (const webRouter of webRouterInfo) {
-            let url = (prefix + webRouter.path).replace('//', '/');
-            url = replaceUrl(url, parseParamsInPath(url));
-            const router = new document_1.SwaggerDocumentRouter(webRouter.requestMethod, url);
-            router.tags = [tag.name];
-            this.generateRouter(webRouter, router, module);
-            this.document.addRouter(router);
+        const webRouterInfo = (0, decorator_1.getClassMetadata)(decorator_1.WEB_ROUTER_KEY, module);
+        if (webRouterInfo && typeof webRouterInfo[Symbol.iterator] === 'function') {
+            for (const webRouter of webRouterInfo) {
+                let url = (prefix + webRouter.path).replace('//', '/');
+                url = replaceUrl(url, parseParamsInPath(url));
+                const router = new document_1.SwaggerDocumentRouter(webRouter.requestMethod, url);
+                router.tags = [tag.name];
+                this.generateRouter(webRouter, router, module);
+                this.document.addRouter(router);
+            }
         }
     }
     generate() {
@@ -49,7 +51,7 @@ class SwaggerMetaGenerator {
     }
     generateRouter(webRouterInfo, swaggerRouter, module) {
         const ins = new module();
-        const swaggerApi = decorator_1.getPropertyMetadata(createAPI_1.SWAGGER_DOCUMENT_KEY, ins, webRouterInfo.method);
+        const swaggerApi = (0, decorator_1.getPropertyMetadata)(createAPI_1.SWAGGER_DOCUMENT_KEY, ins, webRouterInfo.method);
         swaggerRouter.summary =
             (swaggerApi === null || swaggerApi === void 0 ? void 0 : swaggerApi.summary) || webRouterInfo.summary || webRouterInfo.routerName;
         swaggerRouter.description =
@@ -58,9 +60,9 @@ class SwaggerMetaGenerator {
                 webRouterInfo.routerName;
         // swaggerRouter.operationId = webRouterInfo.method;
         swaggerRouter.parameters = [];
-        const routeArgsInfo = decorator_1.getPropertyDataFromClass(decorator_1.WEB_ROUTER_PARAM_KEY, module, webRouterInfo.method) || [];
+        const routeArgsInfo = (0, decorator_1.getPropertyDataFromClass)(decorator_1.WEB_ROUTER_PARAM_KEY, module, webRouterInfo.method) || [];
         // 获取方法参数类型
-        const paramTypes = decorator_1.getMethodParamTypes(ins, webRouterInfo.method);
+        const paramTypes = (0, decorator_1.getMethodParamTypes)(ins, webRouterInfo.method);
         for (const routeArgs of routeArgsInfo) {
             const swaggerParameter = new document_1.SwaggerDocumentParameter();
             const argsApiInfo = swaggerApi === null || swaggerApi === void 0 ? void 0 : swaggerApi.params[routeArgs.index];
@@ -78,7 +80,7 @@ class SwaggerMetaGenerator {
                     continue;
                 }
             }
-            if (decorator_1.isClass(paramTypes[routeArgs.index])) {
+            if ((0, decorator_1.isClass)(paramTypes[routeArgs.index])) {
                 this.generateSwaggerDefinition(paramTypes[routeArgs.index]);
                 swaggerParameter.schema = {
                     $ref: '#/components/schemas/' + paramTypes[routeArgs.index].name,
@@ -124,16 +126,16 @@ class SwaggerMetaGenerator {
         const swaggerDefinition = new document_1.SwaggerDefinition();
         swaggerDefinition.name = definitionClass.name;
         swaggerDefinition.type = 'object';
-        const properties = decorator_1.getClassMetadata(createAPI_1.SWAGGER_DOCUMENT_KEY, definitionClass);
+        const properties = (0, decorator_1.getClassMetadata)(createAPI_1.SWAGGER_DOCUMENT_KEY, definitionClass);
         for (const propertyName in properties) {
             swaggerDefinition.properties[propertyName] = {
-                type: properties[propertyName].type,
+                type: properties[propertyName].type.toLowerCase(),
                 description: properties[propertyName].description,
                 example: properties[propertyName].example,
             };
         }
         // for rule decorator
-        const rules = decorator_1.getClassMetadata(decorator_1.RULES_KEY, definitionClass);
+        const rules = (0, decorator_1.getClassExtendedMetadata)(decorator_1.RULES_KEY, definitionClass);
         if (rules) {
             const properties = Object.keys(rules);
             for (const property of properties) {
@@ -141,25 +143,110 @@ class SwaggerMetaGenerator {
                 if (((_b = (_a = rules[property]) === null || _a === void 0 ? void 0 : _a._flags) === null || _b === void 0 ? void 0 : _b.presence) === 'required') {
                     swaggerDefinition.required.push(property);
                 }
+                // 没找到这行代码对应的装饰器
                 // get property description
-                const propertyInfo = decorator_1.getPropertyMetadata(createAPI_1.SWAGGER_DOCUMENT_KEY, definitionClass, property);
-                mixWhenPropertyEmpty(swaggerDefinition.properties, propertyInfo);
+                let propertyInfo = (0, decorator_1.getPropertyMetadata)(createAPI_1.SWAGGER_DOCUMENT_KEY, definitionClass, property);
+                if (!propertyInfo) {
+                    propertyInfo = this.generateSwaggerByJoiProperty(rules[property], joinCamel(definitionClass.name, property));
+                }
+                if (swaggerDefinition.properties[property] && !(propertyInfo === null || propertyInfo === void 0 ? void 0 : propertyInfo.$ref)) {
+                    mixWhenPropertyEmpty(swaggerDefinition.properties[property], propertyInfo);
+                }
+                else {
+                    swaggerDefinition.properties[property] = propertyInfo;
+                }
             }
         }
         this.document.definitions.push(swaggerDefinition);
         // DTO
         for (const key in properties) {
             // 必须加了属性装饰器
-            if (properties[key].originDesign && !properties[key].isBaseType) {
+            if (!(rules === null || rules === void 0 ? void 0 : rules[key]) &&
+                properties[key].originDesign &&
+                !properties[key].isBaseType) {
                 this.generateSwaggerDefinition(properties[key].originDesign);
                 // 把复杂类型属性指向新的定义
                 swaggerDefinition.properties[key] = {};
-                swaggerDefinition.properties[key]['$ref'] = '#/components/schemas/' + properties[key].type;
+                swaggerDefinition.properties[key]['$ref'] =
+                    '#/components/schemas/' + properties[key].type;
             }
         }
     }
+    generateSwaggerByJoiProperty(joiSchema, pathName) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        const describe = joiSchema.describe();
+        if (((_a = describe.flags) === null || _a === void 0 ? void 0 : _a.presence) === 'forbidden') {
+            return undefined;
+        }
+        let define = {
+            type: describe.type,
+            default: (_b = describe.flags) === null || _b === void 0 ? void 0 : _b.default,
+            description: (_c = describe.flags) === null || _c === void 0 ? void 0 : _c.description,
+            example: (_d = describe.examples) === null || _d === void 0 ? void 0 : _d.join(' '),
+        };
+        let min;
+        let max;
+        for (const r of describe.rules || []) {
+            if (r.name === 'min' && r.args) {
+                min = r.args.limit;
+            }
+            else if (r.name === 'max') {
+                max = r.args.limit;
+            }
+        }
+        if ((_e = describe.flags) === null || _e === void 0 ? void 0 : _e.only) {
+            define.enum = describe.allow;
+        }
+        if (describe.invalid) {
+            define.not = { enum: describe.invalid };
+        }
+        switch (describe.type) {
+            case 'string':
+                define.minLength = min;
+                define.maxLength = max;
+                break;
+            case 'number':
+                define.minimum = min;
+                define.maximum = max;
+                if ((_f = describe.rules) === null || _f === void 0 ? void 0 : _f.some(r => r.name === 'integer')) {
+                    define.type = 'integer';
+                }
+                break;
+            case 'date':
+                define.type = 'string';
+                define.format = 'date-time';
+                break;
+            case 'object': {
+                const swaggerDefinition = new document_1.SwaggerDefinition();
+                const schemaMeta = (_g = describe.metas) === null || _g === void 0 ? void 0 : _g.find(m => Boolean(m.id));
+                swaggerDefinition.name = (schemaMeta === null || schemaMeta === void 0 ? void 0 : schemaMeta.id) || pathName;
+                swaggerDefinition.type = 'object';
+                swaggerDefinition.required = [];
+                for (const prop of (_h = joiSchema.$_terms) === null || _h === void 0 ? void 0 : _h.keys) {
+                    if (((_j = prop.schema._flags) === null || _j === void 0 ? void 0 : _j.presence) === 'required') {
+                        swaggerDefinition.required.push(prop.key);
+                    }
+                    swaggerDefinition.properties[prop.key] =
+                        this.generateSwaggerByJoiProperty(prop.schema, joinCamel(pathName, prop.key));
+                }
+                this.document.definitions.push(swaggerDefinition);
+                define = { $ref: '#/components/schemas/' + swaggerDefinition.name };
+                break;
+            }
+            case 'array':
+                define.minItems = min;
+                define.maxItems = max;
+                if (joiSchema.$_terms.items[0]) {
+                    define.items = this.generateSwaggerByJoiProperty(joiSchema.$_terms.items[0], pathName);
+                }
+        }
+        return define;
+    }
 }
 exports.SwaggerMetaGenerator = SwaggerMetaGenerator;
+function joinCamel(word1, word2) {
+    return `${word1}${word2[0].toUpperCase()}${word2.slice(1)}`;
+}
 function convertTypeToString(type) {
     switch (type) {
         case decorator_1.RouteParamTypes.HEADERS:

package/dist/service/generator.d.ts

@@ -1,4 +1,4 @@
-import { SwaggerGeneratorInfoOptions } from "../interface";
+import { SwaggerGeneratorInfoOptions } from '../interface';
 export declare class SwaggerGenerator {
     swaggerConfig: SwaggerGeneratorInfoOptions;
     generate(): {

package/dist/service/generator.js

@@ -15,7 +15,7 @@ const generator_1 = require("../lib/generator");
 const swagger_1 = require("../controller/swagger");
 let SwaggerGenerator = class SwaggerGenerator {
     generate() {
-        const controllerModules = decorator_1.listModule(decorator_1.CONTROLLER_KEY);
+        const controllerModules = (0, decorator_1.listModule)(decorator_1.CONTROLLER_KEY);
         const generator = new generator_1.SwaggerMetaGenerator(this.swaggerConfig);
         for (const module of controllerModules) {
             if (module !== swagger_1.SwaggerController) {
@@ -26,12 +26,12 @@ let SwaggerGenerator = class SwaggerGenerator {
     }
 };
 __decorate([
-    decorator_1.Config('swagger'),
+    (0, decorator_1.Config)('swagger'),
     __metadata("design:type", Object)
 ], SwaggerGenerator.prototype, "swaggerConfig", void 0);
 SwaggerGenerator = __decorate([
-    decorator_1.Provide('swaggerGenerator'),
-    decorator_1.Scope(decorator_1.ScopeEnum.Singleton)
+    (0, decorator_1.Provide)('swaggerGenerator'),
+    (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
 ], SwaggerGenerator);
 exports.SwaggerGenerator = SwaggerGenerator;
 //# sourceMappingURL=generator.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "1.0.5",
+  "version": "1.2.0",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
   "files": [
@@ -8,7 +8,6 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/cli": "^1.0.0",
     "@midwayjs/core": "^2.3.0",
     "@midwayjs/decorator": "^2.3.0",
     "@midwayjs/koa": "^2.3.0",
@@ -18,14 +17,13 @@
   "author": "Harry Chen <czy88840616@gmail.com>",
   "license": "MIT",
   "scripts": {
-    "build": "midway-bin build -c",
-    "test": "midway-bin test --ts",
-    "cov": "midway-bin cov --ts",
-    "ci": "npm run test"
+    "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"
   },
   "repository": {
     "type": "git",
     "url": "http://github.com/midwayjs/midway-component.git"
-  },
-  "gitHead": "eb9c458fd32ce9676cb1e24b22b8aa39858d7d1e"
+  }
 }