@midwayjs/swagger 1.3.0 → 3.0.0-beta.13

package/dist/swaggerMiddleware.js

@@ -0,0 +1,126 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerMiddleware = void 0;
+const core_1 = require("@midwayjs/core");
+const decorator_1 = require("@midwayjs/decorator");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const swaggerExplorer_1 = require("./swaggerExplorer");
+let SwaggerMiddleware = class SwaggerMiddleware {
+    async init() {
+        const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
+        if (getAbsoluteFSPath) {
+            this.swaggerUiAssetPath = getAbsoluteFSPath();
+        }
+    }
+    resolve(app) {
+        if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
+            return async (req, res, next) => {
+                const pathname = req.path;
+                if (!this.swaggerUiAssetPath ||
+                    pathname.indexOf(this.swaggerConfig.swaggerPath) === -1) {
+                    return next();
+                }
+                const arr = pathname.split('/');
+                let lastName = arr.pop();
+                if (lastName === 'index.json') {
+                    res.send(this.swaggerExplorer.getData());
+                    return;
+                }
+                if (!lastName) {
+                    lastName = 'index.html';
+                }
+                let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName), {
+                    encoding: 'utf-8',
+                });
+                if (lastName === 'index.html') {
+                    content = content.replace('"https://petstore.swagger.io/v2/swagger.json"', `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json')`);
+                }
+                const ext = (0, path_1.extname)(lastName);
+                if (ext === '.js') {
+                    res.type('application/javascript');
+                }
+                else if (ext === '.map') {
+                    res.type('application/json');
+                }
+                else if (ext === '.css') {
+                    res.type('text/css');
+                }
+                else if (ext === '.png') {
+                    res.type('image/png');
+                }
+                res.send(content);
+            };
+        }
+        else {
+            return async (ctx, next) => {
+                const pathname = ctx.path;
+                if (!this.swaggerUiAssetPath ||
+                    pathname.indexOf(this.swaggerConfig.swaggerPath) === -1) {
+                    return next();
+                }
+                const arr = pathname.split('/');
+                let lastName = arr.pop();
+                if (lastName === 'index.json') {
+                    ctx.body = this.swaggerExplorer.getData();
+                    return;
+                }
+                if (!lastName) {
+                    lastName = 'index.html';
+                }
+                let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName), {
+                    encoding: 'utf-8',
+                });
+                if (lastName === 'index.html') {
+                    content = content.replace('"https://petstore.swagger.io/v2/swagger.json"', `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json')`);
+                }
+                const ext = (0, path_1.extname)(lastName);
+                if (ext === '.js') {
+                    ctx.set('Content-Type', 'application/javascript');
+                }
+                else if (ext === '.map') {
+                    ctx.set('Content-Type', 'application/json');
+                }
+                else if (ext === '.css') {
+                    ctx.set('Content-Type', 'text/css');
+                }
+                else if (ext === '.png') {
+                    ctx.set('Content-Type', 'image/png');
+                }
+                ctx.body = content;
+            };
+        }
+    }
+    static getName() {
+        return 'swagger';
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('swagger'),
+    __metadata("design:type", Object)
+], SwaggerMiddleware.prototype, "swaggerConfig", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", swaggerExplorer_1.SwaggerExplorer)
+], SwaggerMiddleware.prototype, "swaggerExplorer", void 0);
+__decorate([
+    (0, decorator_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], SwaggerMiddleware.prototype, "init", null);
+SwaggerMiddleware = __decorate([
+    (0, decorator_1.Provide)(),
+    (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
+], SwaggerMiddleware);
+exports.SwaggerMiddleware = SwaggerMiddleware;
+//# sourceMappingURL=swaggerMiddleware.js.map

package/index.d.ts

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

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "1.3.0",
+  "version": "3.0.0-beta.13",
   "main": "dist/index",
-  "typings": "dist/index.d.ts",
+  "typings": "index.d.ts",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^2.3.0",
-    "@midwayjs/decorator": "^2.3.0",
-    "@midwayjs/koa": "^2.3.0",
-    "@midwayjs/mock": "^2.3.0",
+    "@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"
   },
-  "author": "Harry Chen <czy88840616@gmail.com>",
+  "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
@@ -24,7 +25,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "http://github.com/midwayjs/midway-component.git"
+    "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "caf84abfd0372651dc04eb1064d15b7712710096"
+  "gitHead": "d3c47770fee9dce33a8d148882173fd7782864ad"
 }

package/dist/controller/swagger.d.ts

@@ -1,31 +0,0 @@
-import { IMidwayApplication } from '@midwayjs/core';
-import { SwaggerGenerator } from '../service/generator';
-export declare class SwaggerController {
-    swaggerUiAssetPath: string;
-    app: IMidwayApplication;
-    ctx: any;
-    swaggerGenerator: SwaggerGenerator;
-    constructor();
-    renderJSON(): Promise<{
-        openapi: string;
-        info: {
-            description: string;
-            version: string;
-            title: string;
-            termsOfService: any;
-            contact: any;
-            license: any;
-        };
-        host: string;
-        basePath: string;
-        tags: any;
-        schemas: string[];
-        paths: {};
-        components: {
-            schemas: {};
-        };
-    }>;
-    renderSwagger(fileName: string): Promise<string>;
-    getSwaggerUIResource(requestPath: any, encoding?: 'utf-8'): string;
-}
-//# sourceMappingURL=swagger.d.ts.map

package/dist/controller/swagger.js

@@ -1,96 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwaggerController = void 0;
-const decorator_1 = require("@midwayjs/decorator");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const core_1 = require("@midwayjs/core");
-const generator_1 = require("../service/generator");
-let SwaggerController = class SwaggerController {
-    constructor() {
-        const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
-        if (getAbsoluteFSPath) {
-            this.swaggerUiAssetPath = getAbsoluteFSPath();
-        }
-    }
-    async renderJSON() {
-        return this.swaggerGenerator.generate();
-    }
-    async renderSwagger(fileName) {
-        if (!this.swaggerUiAssetPath) {
-            return 'please run "npm install swagger-ui-dist" first';
-        }
-        if (!fileName) {
-            fileName = '/index.html';
-        }
-        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((0, path_1.extname)(fileName));
-                this.ctx.res.set('cache-control', 'public, max-age=604800');
-            }
-            else {
-                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"', "location.href.replace('/swagger-ui/index.html', '/swagger-ui/json')");
-        }
-        else {
-            return this.getSwaggerUIResource(resourceAbsolutePath);
-        }
-    }
-    getSwaggerUIResource(requestPath, encoding) {
-        return (0, fs_1.readFileSync)(requestPath, {
-            encoding,
-        });
-    }
-};
-__decorate([
-    (0, decorator_1.App)(),
-    __metadata("design:type", Object)
-], SwaggerController.prototype, "app", void 0);
-__decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", Object)
-], SwaggerController.prototype, "ctx", void 0);
-__decorate([
-    (0, decorator_1.Inject)(),
-    __metadata("design:type", generator_1.SwaggerGenerator)
-], SwaggerController.prototype, "swaggerGenerator", void 0);
-__decorate([
-    (0, decorator_1.Get)('/json'),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", Promise)
-], SwaggerController.prototype, "renderJSON", null);
-__decorate([
-    (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([
-    (0, decorator_1.Provide)(),
-    (0, decorator_1.Controller)('/swagger-ui'),
-    __metadata("design:paramtypes", [])
-], SwaggerController);
-exports.SwaggerController = SwaggerController;
-//# sourceMappingURL=swagger.js.map

package/dist/interface.d.ts

@@ -1,16 +0,0 @@
-export interface SwaggerGeneratorInfoOptions {
-    title: string;
-    description: string;
-    version: string;
-    termsOfService: string;
-    contact: {
-        name: string;
-        url: string;
-        email: string;
-    };
-    license: {
-        name: string;
-        url: string;
-    };
-}
-//# sourceMappingURL=interface.d.ts.map

package/dist/interface.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=interface.js.map

package/dist/lib/createAPI.d.ts

@@ -1,52 +0,0 @@
-export declare const SWAGGER_DOCUMENT_KEY = "common:swagger_doc_api";
-export interface ApiFormat {
-    summary: string;
-    description: string;
-    params: APIParamFormat[];
-    response: APIResponseFormat[];
-}
-export interface APIParamFormat {
-    name?: string;
-    type?: string;
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-    example?: any;
-    $ref?: string;
-}
-export interface APIPropertyFormat {
-    description: string;
-    example: any;
-}
-export interface APIResponseFormat {
-    status: string;
-    description: string;
-    headers: {
-        [name: string]: {
-            description?: string;
-            type?: string;
-        };
-    };
-    properties: any;
-    content: any;
-    example: any;
-}
-export declare class SwaggerAPI {
-    private _summary;
-    private _description;
-    private _params;
-    private _response;
-    summary(summary: string): SwaggerAPI;
-    description(desc: string): SwaggerAPI;
-    param(description: Partial<APIParamFormat>): SwaggerAPI;
-    param(description: string, options?: Partial<APIParamFormat>): SwaggerAPI;
-    respond(status: number, description?: string, respondType?: string, options?: Partial<APIResponseFormat>): SwaggerAPI;
-    buildJSON(): ApiFormat;
-    build(): (target: any, property: string) => void;
-}
-export declare function CreateApiDoc(): SwaggerAPI;
-export declare function CreateApiDoc(data: any): MethodDecorator;
-export declare function CreateApiPropertyDoc(description: Partial<APIPropertyFormat>): PropertyDecorator;
-export declare function CreateApiPropertyDoc(description: string, options?: Partial<APIPropertyFormat>): PropertyDecorator;
-//# sourceMappingURL=createAPI.d.ts.map

package/dist/lib/createAPI.js

@@ -1,276 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateApiPropertyDoc = exports.CreateApiDoc = exports.SwaggerAPI = exports.SWAGGER_DOCUMENT_KEY = void 0;
-const decorator_1 = require("@midwayjs/decorator");
-exports.SWAGGER_DOCUMENT_KEY = 'common:swagger_doc_api';
-class SwaggerAPI {
-    constructor() {
-        this._params = [];
-        this._response = [];
-    }
-    summary(summary) {
-        this._summary = summary;
-        return this;
-    }
-    description(desc) {
-        this._description = desc;
-        return this;
-    }
-    param(description, options) {
-        if (typeof description === 'string') {
-            this._params.push({
-                description,
-                ...options,
-            });
-        }
-        else {
-            if (!options) {
-                options = {};
-            }
-            options.example = convertExample(description === null || description === void 0 ? void 0 : description.example);
-            this._params.push(options);
-        }
-        return this;
-    }
-    respond(status, description, respondType, options) {
-        const respondContentType = convertRespondType(respondType, options);
-        if (respondContentType) {
-            this._response.push(convertRespondOptions({
-                status,
-                description: description || '',
-                content: respondContentType,
-                ...options,
-            }));
-        }
-        else {
-            this._response.push(convertRespondOptions({
-                status,
-                description: description || '',
-                ...options,
-            }));
-        }
-        return this;
-    }
-    buildJSON() {
-        return {
-            summary: this._summary,
-            description: this._description,
-            params: this._params,
-            response: this._response,
-        };
-    }
-    build() {
-        return (target, property) => {
-            (0, decorator_1.savePropertyMetadata)(exports.SWAGGER_DOCUMENT_KEY, this.buildJSON(), target, property);
-        };
-    }
-}
-exports.SwaggerAPI = SwaggerAPI;
-function CreateApiDoc(data) {
-    if (data) {
-        return (target, property) => { };
-    }
-    else {
-        return new SwaggerAPI();
-    }
-}
-exports.CreateApiDoc = CreateApiDoc;
-function CreateApiPropertyDoc(description, options) {
-    return (target, propertyKey) => {
-        const metadata = (0, decorator_1.getPropertyType)(target, propertyKey);
-        (0, decorator_1.attachClassMetadata)(exports.SWAGGER_DOCUMENT_KEY, {
-            description,
-            type: metadata.name,
-            isBaseType: metadata.isBaseType,
-            originDesign: metadata.originDesign,
-            ...options,
-        }, target, propertyKey);
-    };
-}
-exports.CreateApiPropertyDoc = CreateApiPropertyDoc;
-function convertExample(example, respondType) {
-    if (example === null || example === undefined) {
-        return undefined;
-    }
-    switch (respondType) {
-        case 'object':
-        case 'json':
-        case 'boolean':
-        case 'number':
-            return example;
-    }
-    return example.toString();
-}
-function convertProperties(example, properties) {
-    if (!example && !properties) {
-        return undefined;
-    }
-    if (!properties) {
-        properties = {};
-        const exampleKeys = Object.keys(example);
-        for (let i = 0; i < exampleKeys.length; i++) {
-            const value = example[exampleKeys[i]];
-            const valueType = typeof value;
-            switch (valueType) {
-                case 'boolean':
-                case 'number':
-                case 'string':
-                    properties[exampleKeys[i]] = {
-                        type: valueType,
-                    };
-                    break;
-                case 'object':
-                    if (Array.isArray(value)) {
-                        properties[exampleKeys[i]] = {
-                            type: 'array',
-                            items: {
-                                type: typeof value,
-                                properties: convertProperties(value[0]),
-                            },
-                        };
-                    }
-                    else {
-                        properties[exampleKeys[i]] = {
-                            type: 'object',
-                            properties: convertProperties(example[exampleKeys[i]]),
-                        };
-                    }
-                    break;
-                default:
-                    break;
-            }
-        }
-    }
-    return properties;
-}
-function convertRespondType(respondType, options) {
-    switch (respondType) {
-        case 'text':
-            return {
-                'text/plain': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'object':
-            return {
-                'application/json': {
-                    schema: {
-                        type: 'object',
-                        properties: convertProperties(options === null || options === void 0 ? void 0 : options.example, options.properties),
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'json':
-            return {
-                'application/json': {
-                    schema: {
-                        type: 'object',
-                        properties: convertProperties(options === null || options === void 0 ? void 0 : options.example, options.properties),
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'boolean':
-            return {
-                'text/plain': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'number':
-            return {
-                'text/plain': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'html':
-            return {
-                'text/html': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'css':
-            return {
-                'text/css': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'js':
-            return {
-                'application/javascript': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'svg':
-            return {
-                'image/svg+xml': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'gif':
-            return {
-                'image/gif': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'jpg':
-            return {
-                'image/jpeg': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        case 'png':
-            return {
-                'mage/png': {
-                    schema: {
-                        type: 'string',
-                        example: convertExample(options === null || options === void 0 ? void 0 : options.example, respondType),
-                    },
-                },
-            };
-        default:
-            return undefined;
-    }
-}
-function convertRespondOptions(respond) {
-    if (respond.headers) {
-        for (const headerName in respond.headers) {
-            const originRespondHeader = respond.headers[headerName];
-            respond.headers[headerName] = {
-                description: originRespondHeader.description,
-                schema: {
-                    type: originRespondHeader.type,
-                },
-            };
-        }
-    }
-    return respond;
-}
-//# sourceMappingURL=createAPI.js.map