@midwayjs/swagger 3.20.5 → 3.20.6-beta.2

package/dist/interfaces/index.d.ts

@@ -280,6 +280,10 @@ export interface AuthOptions extends Omit<SecuritySchemeObject, 'type'> {
      * authType = cookie 时可以修改，cookie 的名称
      */
     cookieName?: string;
+    /**
+     * 添加全局默认要求
+     */
+    addSecurityRequirements?: boolean;
 }
 /**
  * see https://swagger.io/specification/

package/dist/swaggerExplorer.js

@@ -225,7 +225,11 @@ let SwaggerExplorer = class SwaggerExplorer {
                     return item.key === constants_1.DECORATORS.API_EXCLUDE_SECURITY;
                 });
                 // 如果存在安全信息，则将其添加到路径中
-                if (security.length > 0 && !excludeSecurity) {
+                if (excludeSecurity) {
+                    // 显式设置为空数组，覆盖全局 security
+                    paths[url][webRouter.requestMethod].security = [];
+                }
+                else if (security.length > 0) {
                     if (!paths[url][webRouter.requestMethod].security) {
                         paths[url][webRouter.requestMethod].security = [];
                     }
@@ -854,52 +858,40 @@ let SwaggerExplorer = class SwaggerExplorer {
         if (!opts) {
             return;
         }
-        const authType = opts.authType;
-        delete opts.authType;
-        // TODO 加 security
+        const { authType, name = '', addSecurityRequirements = false, ...otherOptions } = opts;
+        if (!authType) {
+            return;
+        }
         switch (authType) {
-            case 'basic':
-                {
-                    const name = opts.name;
-                    delete opts.name;
-                    this.documentBuilder.addBasicAuth(opts, name);
-                }
+            case 'basic': {
+                this.documentBuilder.addBasicAuth(otherOptions, name);
                 break;
-            case 'bearer':
-                {
-                    const name = opts.name;
-                    delete opts.name;
-                    this.documentBuilder.addBearerAuth(opts, name);
-                }
+            }
+            case 'bearer': {
+                this.documentBuilder.addBearerAuth(otherOptions, name);
                 break;
-            case 'cookie':
-                {
-                    const cname = opts.cookieName;
-                    const secName = opts.securityName;
-                    delete opts.cookieName;
-                    delete opts.securityName;
-                    this.documentBuilder.addCookieAuth(cname, opts, secName);
-                }
+            }
+            case 'cookie': {
+                const { cookieName, securityName, ...options } = otherOptions;
+                this.documentBuilder.addCookieAuth(cookieName, options, securityName);
                 break;
-            case 'oauth2':
-                {
-                    const name = opts.name;
-                    delete opts.name;
-                    this.documentBuilder.addOAuth2(opts, name);
-                }
+            }
+            case 'oauth2': {
+                this.documentBuilder.addOAuth2(otherOptions, name);
                 break;
-            case 'apikey':
-                {
-                    const name = opts.name;
-                    delete opts.name;
-                    this.documentBuilder.addApiKey(opts, name);
-                }
+            }
+            case 'apikey': {
+                this.documentBuilder.addApiKey(otherOptions, name);
                 break;
-            case 'custom':
-                {
-                    this.documentBuilder.addSecurity(opts === null || opts === void 0 ? void 0 : opts.name, opts);
-                }
+            }
+            case 'custom': {
+                this.documentBuilder.addSecurity(name, otherOptions);
                 break;
+            }
+        }
+        if (addSecurityRequirements) {
+            // 添加安全要求
+            this.documentBuilder.addSecurityRequirements(name);
         }
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.20.5",
+  "version": "3.20.6-beta.2",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -14,7 +14,8 @@
     "@midwayjs/koa": "^3.20.5",
     "@midwayjs/mock": "^3.20.4",
     "@midwayjs/validate": "^3.20.5",
-    "swagger-ui-dist": "5.18.3"
+    "swagger-ui-dist": "5.18.3",
+    "@apidevtools/swagger-parser": "11.0.1"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -26,6 +27,5 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
-  },
-  "gitHead": "7ce57281bd3ef5d18dc50b47ff9bffb8a27c071e"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-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.