@midwayjs/swagger 3.20.6-beta.3 → 3.20.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -1,2 +1,2 @@
-export declare function ApiBasicAuth(name?: string): ClassDecorator;
+export declare function ApiBasicAuth(name?: string): ClassDecorator & MethodDecorator;
 //# 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): ClassDecorator;
+export declare function ApiBearerAuth(name?: string): ClassDecorator & MethodDecorator;
 //# 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): ClassDecorator;
+export declare function ApiCookieAuth(name?: string): ClassDecorator & MethodDecorator;
 //# sourceMappingURL=api-cookie.decorator.d.ts.map

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

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

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

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

package/dist/swaggerExplorer.js

@@ -162,8 +162,8 @@ let SwaggerExplorer = class SwaggerExplorer {
         if (headers.length > 0) {
             headers = headers.map(item => item.metadata);
         }
-        // 过滤出安全信息
-        const security = metaForClass.filter(item => item.key === constants_1.DECORATORS.API_SECURITY);
+        // 过滤出安全信息（方法优先）
+        const classSecurity = metaForClass.filter(item => item.key === constants_1.DECORATORS.API_SECURITY);
         // 初始化路径对象
         const paths = {};
         // 如果存在路由信息，则遍历生成路径
@@ -174,6 +174,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 url = replaceUrl(url, parseParamsInPath(url));
                 // 方法元数据
                 const metaForMethods = (0, core_1.getPropertyDataFromClass)(constants_1.DECORATORS_METHOD_METADATA, target, webRouter.method) || [];
+                const methodSecurity = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_SECURITY);
                 // 判断是否忽略当前路由
                 const endpoints = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_EXCLUDE_ENDPOINT &&
                     item.propertyName === webRouter.method);
@@ -221,25 +222,26 @@ let SwaggerExplorer = class SwaggerExplorer {
                         Object.assign(paths[url][webRouter.requestMethod], e.metadata);
                     }
                 }
-                // 检查类和方法上的 ApiExcludeSecurity
-                const excludeSecurityClass = metaForClass.find(item => item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY);
-                const excludeSecurityMethod = metaForMethods.find(item => item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY);
-                const excludeSecurity = excludeSecurityClass || excludeSecurityMethod;
-                // 如果存在安全信息，则将其添加到路径中
-                if (excludeSecurity) {
-                    // 显式设置为空数组，覆盖全局 security
+                // 优先级处理：method exclude > method security > class exclude > class security
+                const hasMethodExclude = metaForMethods.find(item => item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY);
+                const hasMethodSecurity = methodSecurity.length > 0;
+                const hasClassExclude = metaForClass.find(item => item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY);
+                const hasClassSecurity = classSecurity.length > 0;
+                if (hasMethodExclude) {
                     paths[url][webRouter.requestMethod].security = [];
                 }
-                else if (security.length > 0) {
-                    if (!paths[url][webRouter.requestMethod].security) {
-                        paths[url][webRouter.requestMethod].security = [];
-                    }
-                    for (const s of security) {
-                        if (!s.metadata) {
-                            continue;
-                        }
-                        paths[url][webRouter.requestMethod].security.push(s.metadata);
-                    }
+                else if (hasMethodSecurity) {
+                    paths[url][webRouter.requestMethod].security = methodSecurity
+                        .map(s => s.metadata)
+                        .filter(Boolean);
+                }
+                else if (hasClassExclude) {
+                    paths[url][webRouter.requestMethod].security = [];
+                }
+                else if (hasClassSecurity) {
+                    paths[url][webRouter.requestMethod].security = classSecurity
+                        .map(s => s.metadata)
+                        .filter(Boolean);
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.20.6-beta.3",
+  "version": "3.20.11",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,12 +10,12 @@
     "index.html"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.20.4",
-    "@midwayjs/koa": "^3.20.5",
-    "@midwayjs/mock": "^3.20.4",
-    "@midwayjs/validate": "^3.20.5",
-    "swagger-ui-dist": "5.18.3",
-    "@apidevtools/swagger-parser": "11.0.1"
+    "@apidevtools/swagger-parser": "11.0.1",
+    "@midwayjs/core": "^3.20.11",
+    "@midwayjs/koa": "^3.20.11",
+    "@midwayjs/mock": "^3.20.11",
+    "@midwayjs/validate": "^3.20.11",
+    "swagger-ui-dist": "5.18.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -27,5 +27,6 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
-  }
+  },
+  "gitHead": "741e5e2cd200d44182bf893f348f58fb5c4e5404"
 }