@midwayjs/swagger 3.14.13 → 3.15.0

package/dist/constants.d.ts

@@ -1,4 +1,6 @@
 export declare const DECORATORS_PREFIX = "swagger";
+export declare const DECORATORS_CLASS_METADATA = "swagger:class_metadata";
+export declare const DECORATORS_METHOD_METADATA = "swagger:method_metadata";
 export declare const DECORATORS: {
     API_OPERATION: string;
     API_RESPONSE: string;
@@ -9,6 +11,7 @@ export declare const DECORATORS: {
     API_EXTRA_MODEL: string;
     API_MODEL_PROPERTIES_ARRAY: string;
     API_SECURITY: string;
+    API_EXCLUDE_SECURITY: string;
     API_EXCLUDE_ENDPOINT: string;
     API_EXCLUDE_CONTROLLER: string;
     API_EXTENSION: string;

package/dist/constants.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DECORATORS = exports.DECORATORS_PREFIX = void 0;
+exports.DECORATORS = exports.DECORATORS_METHOD_METADATA = exports.DECORATORS_CLASS_METADATA = exports.DECORATORS_PREFIX = void 0;
 exports.DECORATORS_PREFIX = 'swagger';
+exports.DECORATORS_CLASS_METADATA = 'swagger:class_metadata';
+exports.DECORATORS_METHOD_METADATA = 'swagger:method_metadata';
 exports.DECORATORS = {
     API_OPERATION: `${exports.DECORATORS_PREFIX}/apiOperation`,
     API_RESPONSE: `${exports.DECORATORS_PREFIX}/apiResponse`,
@@ -12,6 +14,7 @@ exports.DECORATORS = {
     API_EXTRA_MODEL: `${exports.DECORATORS_PREFIX}/apiExtraModel`,
     API_MODEL_PROPERTIES_ARRAY: `${exports.DECORATORS_PREFIX}/apiModelPropertiesArray`,
     API_SECURITY: `${exports.DECORATORS_PREFIX}/apiSecurity`,
+    API_EXCLUDE_SECURITY: `${exports.DECORATORS_PREFIX}/apiExcludeSecurity`,
     API_EXCLUDE_ENDPOINT: `${exports.DECORATORS_PREFIX}/apiExcludeEndpoint`,
     API_EXCLUDE_CONTROLLER: `${exports.DECORATORS_PREFIX}/apiExcludeController`,
     API_EXTENSION: `${exports.DECORATORS_PREFIX}/apiExtension`,

package/dist/decorators/api-basic.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiBasicAuth(name?: string): any;
+export declare function ApiBasicAuth(name?: string): ClassDecorator;
 //# sourceMappingURL=api-basic.decorator.d.ts.map

package/dist/decorators/api-bearer.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiBearerAuth(name?: string): any;
+export declare function ApiBearerAuth(name?: string): ClassDecorator;
 //# sourceMappingURL=api-bearer.decorator.d.ts.map

package/dist/decorators/api-cookie.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiCookieAuth(name?: string): any;
+export declare function ApiCookieAuth(name?: string): ClassDecorator;
 //# sourceMappingURL=api-cookie.decorator.d.ts.map

package/dist/decorators/api-exclude-endpoint.decorator.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiExcludeEndpoint = void 0;
-const core_1 = require("@midwayjs/core");
 const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
 function ApiExcludeEndpoint(disable = true) {
-    return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_ENDPOINT, {
-        disable,
-    }, false);
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXCLUDE_ENDPOINT, true);
 }
 exports.ApiExcludeEndpoint = ApiExcludeEndpoint;
 //# sourceMappingURL=api-exclude-endpoint.decorator.js.map

package/dist/decorators/api-extension.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiExtension(extensionKey: string, extensionProperties: any): any;
+export declare function ApiExtension(extensionKey: string, extensionProperties: any): ClassDecorator & MethodDecorator;
 //# sourceMappingURL=api-extension.decorator.d.ts.map

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

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

package/dist/decorators/api-header.decorator.js

@@ -4,7 +4,6 @@ exports.ApiHeaders = exports.ApiHeader = void 0;
 const constants_1 = require("../constants");
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
-const core_1 = require("@midwayjs/core");
 const defaultHeaderOptions = {
     name: '',
 };
@@ -30,7 +29,7 @@ function ApiHeader(options) {
         if (descriptor) {
             return (0, helpers_1.createParamDecorator)(param, defaultHeaderOptions)(target, key, descriptor);
         }
-        return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_HEADERS, param, false)(target, undefined, undefined);
+        return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_HEADERS, param)(target, undefined, undefined);
     };
 }
 exports.ApiHeader = ApiHeader;

package/dist/decorators/api-oauth2.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiOAuth2(scopes: string[], name?: string): any;
+export declare function ApiOAuth2(scopes: string[], name?: string): ClassDecorator;
 //# sourceMappingURL=api-oauth2.decorator.d.ts.map

package/dist/decorators/api-operation.decorator.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiOperation = void 0;
-const core_1 = require("@midwayjs/core");
 const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
 const defaultOperationOptions = {
     summary: '',
 };
 function ApiOperation(options) {
-    return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_OPERATION, {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_OPERATION, {
         ...defaultOperationOptions,
         ...options,
-    }, false);
+    });
 }
 exports.ApiOperation = ApiOperation;
 //# sourceMappingURL=api-operation.decorator.js.map

package/dist/decorators/api-response.decorator.js

@@ -4,7 +4,6 @@ exports.ApiDefaultResponse = exports.ApiUnsupportedMediaTypeResponse = exports.A
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 const httpStatus_1 = require("../common/httpStatus");
-const core_1 = require("@midwayjs/core");
 function ApiResponse(options) {
     const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(options.type, options.isArray);
     options.type = type;
@@ -13,7 +12,7 @@ function ApiResponse(options) {
     const groupedMetadata = {
         [options.status || 'default']: options,
     };
-    return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_RESPONSE, groupedMetadata, false);
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_RESPONSE, groupedMetadata);
 }
 exports.ApiResponse = ApiResponse;
 const ApiOkResponse = (options = {}) => ApiResponse({

package/dist/decorators/api-security.decorator.d.ts

@@ -1,3 +1,4 @@
 import { SecurityRequirementObject } from '../interfaces';
-export declare function ApiSecurity(name: string | SecurityRequirementObject, requirements?: string[]): any;
+export declare function ApiSecurity(name: string | SecurityRequirementObject, requirements?: string[]): ClassDecorator;
+export declare function ApiExcludeSecurity(): MethodDecorator;
 //# sourceMappingURL=api-security.decorator.d.ts.map

package/dist/decorators/api-security.decorator.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiSecurity = void 0;
-const core_1 = require("@midwayjs/core");
+exports.ApiExcludeSecurity = exports.ApiSecurity = void 0;
 const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
 function ApiSecurity(name, requirements = []) {
     let metadata;
     if (typeof name === 'string') {
@@ -11,7 +11,11 @@ function ApiSecurity(name, requirements = []) {
     else {
         metadata = name;
     }
-    return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_SECURITY, metadata, false);
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_SECURITY, metadata);
 }
 exports.ApiSecurity = ApiSecurity;
+function ApiExcludeSecurity() {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXCLUDE_SECURITY, true);
+}
+exports.ApiExcludeSecurity = ApiExcludeSecurity;
 //# sourceMappingURL=api-security.decorator.js.map

package/dist/decorators/api-tags.decorator.d.ts

@@ -1,2 +1,2 @@
-export declare function ApiTags(tags: string | string[]): any;
+export declare function ApiTags(tags: string | string[]): ClassDecorator & MethodDecorator;
 //# sourceMappingURL=api-tags.decorator.d.ts.map

package/dist/decorators/helpers.d.ts

@@ -1,6 +1,6 @@
 import type { Type } from '../interfaces';
 export declare function createPropertyDecorator<T extends Record<string, any> = any>(metakey: string, metadata: T): PropertyDecorator;
-export declare function createMixedDecorator<T = any>(metakey: string, metadata: T): any;
+export declare function createMixedDecorator<T = any>(metakey: string, metadata: T): ClassDecorator & MethodDecorator;
 export declare function createParamDecorator<T extends Record<string, any> = any>(metadata: T, initial: Partial<T>): MethodDecorator;
 export declare function getTypeIsArrayTuple(input: Type | undefined | string | Record<string, any>, isArrayFlag: boolean): [Type | undefined | string | Record<string, any>, boolean];
 export declare function getSchemaPath(clzz: Type | string): string;

package/dist/decorators/helpers.js

@@ -8,14 +8,28 @@ function createPropertyDecorator(metakey, metadata) {
 }
 exports.createPropertyDecorator = createPropertyDecorator;
 function createMixedDecorator(metakey, metadata) {
-    return (0, core_1.createCustomMethodDecorator)(metakey, metadata, false);
+    return (target, methodName) => {
+        if (methodName) {
+            (0, core_1.attachPropertyDataToClass)(constants_1.DECORATORS_METHOD_METADATA, {
+                key: metakey,
+                propertyName: methodName,
+                metadata,
+            }, target, methodName);
+        }
+        else {
+            (0, core_1.attachClassMetadata)(constants_1.DECORATORS_CLASS_METADATA, {
+                key: metakey,
+                metadata,
+            }, target);
+        }
+    };
 }
 exports.createMixedDecorator = createMixedDecorator;
 function createParamDecorator(metadata, initial) {
-    return (0, core_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_PARAMETERS, {
+    return createMixedDecorator(constants_1.DECORATORS.API_PARAMETERS, {
         ...initial,
         ...metadata,
-    }, false);
+    });
 }
 exports.createParamDecorator = createParamDecorator;
 function getTypeIsArrayTuple(input, isArrayFlag) {

package/dist/interfaces/index.d.ts

@@ -374,4 +374,9 @@ export interface SwaggerOptions {
      */
     routerFilter?: (url: string, options: RouterOption) => boolean;
 }
+export interface MixDecoratorMetadata {
+    key: string;
+    metadata: any;
+    propertyName?: string;
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/swaggerExplorer.js

@@ -105,8 +105,7 @@ let SwaggerExplorer = class SwaggerExplorer {
         }
         // 解析额外的模型
         this.parseExtraModel(target);
-        // 获取方法的元数据
-        const metaForClass = (0, core_1.getClassMetadata)(core_1.INJECT_CUSTOM_METHOD, target) || [];
+        const metaForClass = (0, core_1.getClassMetadata)(constants_1.DECORATORS_CLASS_METADATA, target) || [];
         // 获取参数的元数据
         const metaForParams = (0, core_1.getClassMetadata)(core_1.INJECT_CUSTOM_PARAM, target) || [];
         // 获取控制器选项
@@ -165,8 +164,10 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // 生成URL
                 let url = (prefix + webRouter.path).replace('//', '/');
                 url = replaceUrl(url, parseParamsInPath(url));
+                // 方法元数据
+                const metaForMethods = (0, core_1.getPropertyDataFromClass)(constants_1.DECORATORS_METHOD_METADATA, target, webRouter.method) || [];
                 // 判断是否忽略当前路由
-                const endpoints = metaForClass.filter(item => item.key === constants_1.DECORATORS.API_EXCLUDE_ENDPOINT &&
+                const endpoints = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXCLUDE_ENDPOINT &&
                     item.propertyName === webRouter.method);
                 // 如果存在需要忽略的路由，则跳过当前循环
                 if (endpoints[0]) {
@@ -192,13 +193,13 @@ let SwaggerExplorer = class SwaggerExplorer {
                     continue;
                 }
                 // 生成路由方法
-                this.generateRouteMethod(url, webRouter, paths, metaForClass, routerArgs, headers, target);
+                this.generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, headers, target);
                 // 如果当前路径的标签长度为0，则赋值标签
                 if (paths[url][webRouter.requestMethod].tags.length === 0) {
                     paths[url][webRouter.requestMethod].tags = strTags;
                 }
                 // 过滤出扩展信息
-                const exts = metaForClass.filter(item => item.key === constants_1.DECORATORS.API_EXTENSION &&
+                const exts = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXTENSION &&
                     item.propertyName === webRouter.method);
                 // 如果存在扩展信息，则将其添加到路径中
                 for (const e of exts) {
@@ -206,8 +207,11 @@ let SwaggerExplorer = class SwaggerExplorer {
                         Object.assign(paths[url][webRouter.requestMethod], e.metadata);
                     }
                 }
+                const excludeSecurity = metaForMethods.find(item => {
+                    return item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY;
+                });
                 // 如果存在安全信息，则将其添加到路径中
-                if (security.length > 0) {
+                if (security.length > 0 && !excludeSecurity) {
                     if (!paths[url][webRouter.requestMethod].security) {
                         paths[url][webRouter.requestMethod].security = [];
                     }
@@ -559,8 +563,8 @@ let SwaggerExplorer = class SwaggerExplorer {
      * @param clzz
      */
     parseExtraModel(clzz) {
-        const metaForMethods = (0, core_1.getClassMetadata)(core_1.INJECT_CUSTOM_METHOD, clzz) || [];
-        const extraModels = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXTRA_MODEL);
+        const metaForClass = (0, core_1.getClassMetadata)(constants_1.DECORATORS_CLASS_METADATA, clzz) || [];
+        const extraModels = metaForClass.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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.14.13",
+  "version": "3.15.0",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,11 +10,11 @@
     "index.html"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.14.12",
-    "@midwayjs/koa": "^3.14.12",
-    "@midwayjs/mock": "^3.14.12",
-    "@midwayjs/validate": "^3.14.12",
-    "swagger-ui-dist": "5.11.3"
+    "@midwayjs/core": "^3.15.0",
+    "@midwayjs/koa": "^3.15.0",
+    "@midwayjs/mock": "^3.15.0",
+    "@midwayjs/validate": "^3.15.0",
+    "swagger-ui-dist": "5.11.7"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -28,5 +28,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "d145ad36adb40cfe7bf780e2ec07049d5ee90bdd"
+  "gitHead": "be0a091f940aa60965d9fabfbdcbf0fe2830e9c4"
 }