@midwayjs/swagger 4.0.0-alpha.1 → 4.0.0-beta.1

package/README.md

@@ -8,4 +8,4 @@ Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 
-[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT]((https://github.com/midwayjs/midway/blob/master/LICENSE))

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 ApiExcludeSecurity(): MethodDecorator;
+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/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

@@ -159,8 +159,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 = {};
         // 如果存在路由信息，则遍历生成路径
@@ -171,6 +171,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 url = replaceUrl(url, parseParamsInPath(url));
                 // 方法元数据
                 const metaForMethods = core_1.MetadataManager.getMetadata(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);
@@ -215,20 +216,26 @@ 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 && !excludeSecurity) {
-                    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);
-                    }
+                // 优先级处理：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 (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);
                 }
             }
         }
@@ -513,7 +520,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     }
                     else {
                         tt.content = {
-                            'text/plan': {
+                            'text/plain': {
                                 schema: {
                                     type: convertSchemaType(tt.type),
                                 },
@@ -847,52 +854,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?.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": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.1",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,11 +10,12 @@
     "index.html"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/koa": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1",
-    "@midwayjs/validate": "^4.0.0-alpha.1",
-    "swagger-ui-dist": "5.18.2"
+    "@apidevtools/swagger-parser": "11.0.1",
+    "@midwayjs/core": "^4.0.0-beta.1",
+    "@midwayjs/koa": "^4.0.0-beta.1",
+    "@midwayjs/mock": "^4.0.0-beta.1",
+    "@midwayjs/validate": "^4.0.0-beta.1",
+    "swagger-ui-dist": "5.18.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -28,5 +29,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
 }

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.