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

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/common/enum.utils.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEnumMetadata = exports.isEnumDefined = exports.isEnumArray = exports.addEnumSchema = exports.addEnumArraySchema = exports.getEnumType = exports.getEnumValues = void 0;
+exports.isEnumMetadata = exports.isEnumDefined = exports.isEnumArray = void 0;
+exports.getEnumValues = getEnumValues;
+exports.getEnumType = getEnumType;
+exports.addEnumArraySchema = addEnumArraySchema;
+exports.addEnumSchema = addEnumSchema;
 function getEnumValues(enumType) {
     if (Array.isArray(enumType)) {
         return enumType;
@@ -13,12 +17,10 @@ function getEnumValues(enumType) {
         .map(key => enumType[key]);
     return Array.from(new Set(values));
 }
-exports.getEnumValues = getEnumValues;
 function getEnumType(values) {
     const hasString = values.filter(s => typeof s === 'string').length > 0;
     return hasString ? 'string' : 'number';
 }
-exports.getEnumType = getEnumType;
 function addEnumArraySchema(paramDefinition, decoratorOptions) {
     const paramSchema = paramDefinition.schema || {};
     paramDefinition.schema = paramSchema;
@@ -33,7 +35,6 @@ function addEnumArraySchema(paramDefinition, decoratorOptions) {
         paramDefinition.enumName = decoratorOptions.enumName;
     }
 }
-exports.addEnumArraySchema = addEnumArraySchema;
 function addEnumSchema(paramDefinition, decoratorOptions) {
     const paramSchema = paramDefinition.schema || {};
     const enumValues = getEnumValues(decoratorOptions.enum);
@@ -44,7 +45,6 @@ function addEnumSchema(paramDefinition, decoratorOptions) {
         paramDefinition.enumName = decoratorOptions.enumName;
     }
 }
-exports.addEnumSchema = addEnumSchema;
 const isEnumArray = (obj) => obj.isArray && obj.enum;
 exports.isEnumArray = isEnumArray;
 const isEnumDefined = (obj) => obj.enum;

package/dist/configuration.js

@@ -14,6 +14,8 @@ const core_1 = require("@midwayjs/core");
 const _1 = require(".");
 const DefaultConfig = require("./config/config.default");
 let SwaggerConfiguration = class SwaggerConfiguration {
+    applicationManager;
+    configService;
     async onReady(container) {
         const apps = this.applicationManager.getApplications([
             'express',

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-basic.decorator.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBasicAuth = void 0;
+exports.ApiBasicAuth = ApiBasicAuth;
 const api_security_decorator_1 = require("./api-security.decorator");
 function ApiBasicAuth(name = 'basic') {
     return (0, api_security_decorator_1.ApiSecurity)(name);
 }
-exports.ApiBasicAuth = ApiBasicAuth;
 //# sourceMappingURL=api-basic.decorator.js.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-bearer.decorator.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBearerAuth = void 0;
+exports.ApiBearerAuth = ApiBearerAuth;
 const api_security_decorator_1 = require("./api-security.decorator");
 function ApiBearerAuth(name = 'bearer') {
     return (0, api_security_decorator_1.ApiSecurity)(name);
 }
-exports.ApiBearerAuth = ApiBearerAuth;
 //# sourceMappingURL=api-bearer.decorator.js.map

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBody = exports.BodyContentType = void 0;
+exports.BodyContentType = void 0;
+exports.ApiBody = ApiBody;
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
 var BodyContentType;
@@ -31,5 +32,4 @@ function ApiBody(options) {
     }
     return (0, helpers_1.createParamDecorator)(param, defaultBodyMetadata);
 }
-exports.ApiBody = ApiBody;
 //# sourceMappingURL=api-body.decorator.js.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-cookie.decorator.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiCookieAuth = void 0;
+exports.ApiCookieAuth = ApiCookieAuth;
 const api_security_decorator_1 = require("./api-security.decorator");
 function ApiCookieAuth(name = 'cookie') {
     return (0, api_security_decorator_1.ApiSecurity)(name);
 }
-exports.ApiCookieAuth = ApiCookieAuth;
 //# sourceMappingURL=api-cookie.decorator.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiExcludeController = void 0;
+exports.ApiExcludeController = ApiExcludeController;
 const core_1 = require("@midwayjs/core");
 const constants_1 = require("../constants");
 function ApiExcludeController(disable = true) {
@@ -8,5 +8,4 @@ function ApiExcludeController(disable = true) {
         core_1.MetadataManager.defineMetadata(constants_1.DECORATORS.API_EXCLUDE_CONTROLLER, { disable }, target);
     };
 }
-exports.ApiExcludeController = ApiExcludeController;
 //# sourceMappingURL=api-exclude-controller.decorator.js.map

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

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiExcludeEndpoint = void 0;
+exports.ApiExcludeEndpoint = ApiExcludeEndpoint;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 function ApiExcludeEndpoint(disable = true) {
     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.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiExtension = void 0;
+exports.ApiExtension = ApiExtension;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 function ApiExtension(extensionKey, extensionProperties) {
@@ -12,5 +12,4 @@ function ApiExtension(extensionKey, extensionProperties) {
     };
     return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXTENSION, extensionObject);
 }
-exports.ApiExtension = ApiExtension;
 //# sourceMappingURL=api-extension.decorator.js.map

package/dist/decorators/api-extra-model.decorator.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiExtraModel = void 0;
+exports.ApiExtraModel = ApiExtraModel;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 function ApiExtraModel(models) {
     return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXTRA_MODEL, models);
 }
-exports.ApiExtraModel = ApiExtraModel;
 //# sourceMappingURL=api-extra-model.decorator.js.map

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiHeaders = exports.ApiHeader = void 0;
+exports.ApiHeaders = void 0;
+exports.ApiHeader = ApiHeader;
 const constants_1 = require("../constants");
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
@@ -32,7 +33,6 @@ function ApiHeader(options) {
         return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_HEADERS, param)(target, undefined, undefined);
     };
 }
-exports.ApiHeader = ApiHeader;
 const ApiHeaders = (headers) => {
     return (target, key, descriptor) => {
         headers.forEach(options => ApiHeader(options)(target, key, descriptor));

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-oauth2.decorator.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiOAuth2 = void 0;
+exports.ApiOAuth2 = ApiOAuth2;
 const api_security_decorator_1 = require("./api-security.decorator");
 function ApiOAuth2(scopes, name = 'oauth2') {
     return (0, api_security_decorator_1.ApiSecurity)(name, scopes);
 }
-exports.ApiOAuth2 = ApiOAuth2;
 //# sourceMappingURL=api-oauth2.decorator.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiOperation = void 0;
+exports.ApiOperation = ApiOperation;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 const defaultOperationOptions = {
@@ -12,5 +12,4 @@ function ApiOperation(options) {
         ...options,
     });
 }
-exports.ApiOperation = ApiOperation;
 //# sourceMappingURL=api-operation.decorator.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiParam = void 0;
+exports.ApiParam = ApiParam;
 const helpers_1 = require("./helpers");
 const enum_utils_1 = require("../common/enum.utils");
 const defaultParamOptions = {
@@ -26,5 +26,4 @@ function ApiParam(options) {
     }
     return (0, helpers_1.createParamDecorator)(param, defaultParamOptions);
 }
-exports.ApiParam = ApiParam;
 //# sourceMappingURL=api-param.decorator.js.map

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

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiResponseProperty = exports.ApiPropertyOptional = exports.createApiPropertyDecorator = exports.ApiProperty = void 0;
+exports.ApiProperty = ApiProperty;
+exports.createApiPropertyDecorator = createApiPropertyDecorator;
+exports.ApiPropertyOptional = ApiPropertyOptional;
+exports.ApiResponseProperty = ApiResponseProperty;
 const constants_1 = require("../constants");
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
@@ -8,7 +11,6 @@ const isEnumArray = (obj) => obj.isArray && !!obj.enum;
 function ApiProperty(options = {}) {
     return createApiPropertyDecorator(options);
 }
-exports.ApiProperty = ApiProperty;
 function createApiPropertyDecorator(options = {}) {
     const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(options.type, options.isArray);
     options = {
@@ -37,19 +39,16 @@ function createApiPropertyDecorator(options = {}) {
     }
     return (0, helpers_1.createPropertyDecorator)(constants_1.DECORATORS.API_MODEL_PROPERTIES, options);
 }
-exports.createApiPropertyDecorator = createApiPropertyDecorator;
 function ApiPropertyOptional(options = {}) {
     return ApiProperty({
         ...options,
         required: false,
     });
 }
-exports.ApiPropertyOptional = ApiPropertyOptional;
 function ApiResponseProperty(options = {}) {
     return ApiProperty({
         readOnly: true,
         ...options,
     });
 }
-exports.ApiResponseProperty = ApiResponseProperty;
 //# sourceMappingURL=api-property.decorator.js.map

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiQuery = void 0;
+exports.ApiQuery = ApiQuery;
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
 const defaultQueryOptions = {
@@ -27,5 +27,4 @@ function ApiQuery(options) {
     }
     return (0, helpers_1.createParamDecorator)(param, defaultQueryOptions);
 }
-exports.ApiQuery = ApiQuery;
 //# sourceMappingURL=api-query.decorator.js.map

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiDefaultResponse = exports.ApiUnsupportedMediaTypeResponse = exports.ApiUnprocessableEntityResponse = exports.ApiServiceUnavailableResponse = exports.ApiRequestTimeoutResponse = exports.ApiPayloadTooLargeResponse = exports.ApiPreconditionFailedResponse = exports.ApiNotImplementedResponse = exports.ApiNotAcceptableResponse = exports.ApiMethodNotAllowedResponse = exports.ApiGoneResponse = exports.ApiGatewayTimeoutResponse = exports.ApiForbiddenResponse = exports.ApiConflictResponse = exports.ApiBadGatewayResponse = exports.ApiInternalServerErrorResponse = exports.ApiNotFoundResponse = exports.ApiTooManyRequestsResponse = exports.ApiUnauthorizedResponse = exports.ApiBadRequestResponse = exports.ApiFoundResponse = exports.ApiMovedPermanentlyResponse = exports.ApiNoContentResponse = exports.ApiAcceptedResponse = exports.ApiCreatedResponse = exports.ApiOkResponse = exports.ApiResponse = void 0;
+exports.ApiDefaultResponse = exports.ApiUnsupportedMediaTypeResponse = exports.ApiUnprocessableEntityResponse = exports.ApiServiceUnavailableResponse = exports.ApiRequestTimeoutResponse = exports.ApiPayloadTooLargeResponse = exports.ApiPreconditionFailedResponse = exports.ApiNotImplementedResponse = exports.ApiNotAcceptableResponse = exports.ApiMethodNotAllowedResponse = exports.ApiGoneResponse = exports.ApiGatewayTimeoutResponse = exports.ApiForbiddenResponse = exports.ApiConflictResponse = exports.ApiBadGatewayResponse = exports.ApiInternalServerErrorResponse = exports.ApiNotFoundResponse = exports.ApiTooManyRequestsResponse = exports.ApiUnauthorizedResponse = exports.ApiBadRequestResponse = exports.ApiFoundResponse = exports.ApiMovedPermanentlyResponse = exports.ApiNoContentResponse = exports.ApiAcceptedResponse = exports.ApiCreatedResponse = exports.ApiOkResponse = void 0;
+exports.ApiResponse = ApiResponse;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 const httpStatus_1 = require("../common/httpStatus");
@@ -14,7 +15,6 @@ function ApiResponse(options) {
     };
     return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_RESPONSE, groupedMetadata);
 }
-exports.ApiResponse = ApiResponse;
 const ApiOkResponse = (options = {}) => ApiResponse({
     ...options,
     status: httpStatus_1.HttpStatus.OK,

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/decorators/api-security.decorator.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiExcludeSecurity = exports.ApiSecurity = void 0;
+exports.ApiSecurity = ApiSecurity;
+exports.ApiExcludeSecurity = ApiExcludeSecurity;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 function ApiSecurity(name, requirements = []) {
@@ -13,9 +14,7 @@ function ApiSecurity(name, requirements = []) {
     }
     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.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiTags = void 0;
+exports.ApiTags = ApiTags;
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
 function ApiTags(tags) {
     return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_TAGS, tags);
 }
-exports.ApiTags = ApiTags;
 //# sourceMappingURL=api-tags.decorator.js.map

package/dist/decorators/helpers.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSchemaPath = exports.getTypeIsArrayTuple = exports.createParamDecorator = exports.createMixedDecorator = exports.createPropertyDecorator = void 0;
+exports.createPropertyDecorator = createPropertyDecorator;
+exports.createMixedDecorator = createMixedDecorator;
+exports.createParamDecorator = createParamDecorator;
+exports.getTypeIsArrayTuple = getTypeIsArrayTuple;
+exports.getSchemaPath = getSchemaPath;
 const core_1 = require("@midwayjs/core");
 const constants_1 = require("../constants");
 function createPropertyDecorator(metakey, metadata) {
     return core_1.DecoratorManager.createCustomPropertyDecorator(metakey, metadata, false);
 }
-exports.createPropertyDecorator = createPropertyDecorator;
 function createMixedDecorator(metakey, metadata) {
     return (target, methodName) => {
         if (methodName) {
@@ -24,14 +27,12 @@ function createMixedDecorator(metakey, metadata) {
         }
     };
 }
-exports.createMixedDecorator = createMixedDecorator;
 function createParamDecorator(metadata, initial) {
     return createMixedDecorator(constants_1.DECORATORS.API_PARAMETERS, {
         ...initial,
         ...metadata,
     });
 }
-exports.createParamDecorator = createParamDecorator;
 function getTypeIsArrayTuple(input, isArrayFlag) {
     if (!input) {
         return [input, isArrayFlag];
@@ -43,7 +44,6 @@ function getTypeIsArrayTuple(input, isArrayFlag) {
     const type = isInputArray ? input[0] : input;
     return [type, isInputArray];
 }
-exports.getTypeIsArrayTuple = getTypeIsArrayTuple;
 function getSchemaPath(clzz) {
     let str = clzz;
     if (typeof clzz !== 'string') {
@@ -51,5 +51,4 @@ function getSchemaPath(clzz) {
     }
     return `#/components/schemas/${str}`;
 }
-exports.getSchemaPath = getSchemaPath;
 //# sourceMappingURL=helpers.js.map

package/dist/documentBuilder.js

@@ -2,21 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentBuilder = void 0;
 class DocumentBuilder {
-    constructor() {
-        this.document = {
-            openapi: '3.0.1',
-            info: {
-                title: '',
-                description: '',
-                version: '1.0.0',
-                contact: {},
-            },
-            tags: [],
-            servers: [],
-            components: {},
-            paths: {},
-        };
-    }
+    document = {
+        openapi: '3.0.1',
+        info: {
+            title: '',
+            description: '',
+            version: '1.0.0',
+            contact: {},
+        },
+        tags: [],
+        servers: [],
+        components: {},
+        paths: {},
+    };
     setTitle(title) {
         this.document.info.title = title;
         return this;

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

@@ -16,11 +16,9 @@ const documentBuilder_1 = require("./documentBuilder");
 const _1 = require(".");
 const enum_utils_1 = require("./common/enum.utils");
 let SwaggerExplorer = class SwaggerExplorer {
-    constructor() {
-        this.swaggerConfig = {};
-        this.documentBuilder = new documentBuilder_1.DocumentBuilder();
-        this.operationIdFactory = (controllerKey, webRouter) => `${controllerKey.toLowerCase()}_${webRouter.method.toLocaleLowerCase()}`;
-    }
+    swaggerConfig = {};
+    documentBuilder = new documentBuilder_1.DocumentBuilder();
+    operationIdFactory = (controllerKey, webRouter) => `${controllerKey.toLowerCase()}_${webRouter.method.toLocaleLowerCase()}`;
     async init() {
         this.documentBuilder.setTitle(this.swaggerConfig.title);
         this.documentBuilder.setVersion(this.swaggerConfig.version);
@@ -159,8 +157,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 +169,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 +214,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 +518,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     }
                     else {
                         tt.content = {
-                            'text/plan': {
+                            'text/plain': {
                                 schema: {
                                     type: convertSchemaType(tt.type),
                                 },
@@ -847,52 +852,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/dist/swaggerMiddleware.js

@@ -13,6 +13,10 @@ exports.SwaggerMiddleware = void 0;
 const core_1 = require("@midwayjs/core");
 const swaggerExplorer_1 = require("./swaggerExplorer");
 let SwaggerMiddleware = class SwaggerMiddleware {
+    swaggerConfig;
+    swaggerRender;
+    swaggerExplorer;
+    environmentService;
     async init() {
         if (typeof this.swaggerConfig.swaggerUIRender !== 'function') {
             throw new core_1.MidwayInvalidConfigPropertyError('swagger.swaggerRender');

package/dist/ui/render.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderSwaggerUIRemote = exports.renderJSON = exports.renderSwaggerUIDist = void 0;
+exports.renderSwaggerUIDist = renderSwaggerUIDist;
+exports.renderJSON = renderJSON;
+exports.renderSwaggerUIRemote = renderSwaggerUIRemote;
 const core_1 = require("@midwayjs/core");
 const fs_1 = require("fs");
 const path_1 = require("path");
@@ -21,8 +23,9 @@ function renderSwaggerUIDist(swaggerConfig, swaggerExplorer) {
     function replaceInfo(content) {
         let str = `location.href.replace('${swaggerConfig.swaggerPath}/index.html', '${swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
         if (swaggerConfig.displayOptions) {
-            Object.keys(swaggerConfig.displayOptions).forEach(key => {
-                str += `\n${key}: ${swaggerConfig.displayOptions[key]},`;
+            Object.entries(swaggerConfig.displayOptions).forEach(([key, value]) => {
+                const variable = typeof value === 'string' ? `'${value}'` : value;
+                str += `\n${key}: ${variable},`;
             });
         }
         return content.replace('"https://petstore.swagger.io/v2/swagger.json",', str);
@@ -54,7 +57,6 @@ function renderSwaggerUIDist(swaggerConfig, swaggerExplorer) {
         return { ext, content };
     };
 }
-exports.renderSwaggerUIDist = renderSwaggerUIDist;
 function renderJSON(swaggerConfig, swaggerExplorer) {
     return async (pathname) => {
         if (pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
@@ -68,7 +70,6 @@ function renderJSON(swaggerConfig, swaggerExplorer) {
         return;
     };
 }
-exports.renderJSON = renderJSON;
 function renderSwaggerUIRemote(swaggerConfig, swaggerExplorer) {
     const swaggerRenderOptions = swaggerConfig.swaggerUIRenderOptions || {};
     const indexPagePath = swaggerRenderOptions?.indexPagePath || (0, path_1.join)(__dirname, '../../index.html');
@@ -91,5 +92,4 @@ function renderSwaggerUIRemote(swaggerConfig, swaggerExplorer) {
         return;
     };
 }
-exports.renderSwaggerUIRemote = renderSwaggerUIRemote;
 //# sourceMappingURL=render.js.map

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.10",
+  "description": "Midway Component for Swagger API Documentation",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,11 +11,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.10",
+    "@midwayjs/koa": "^4.0.0-beta.10",
+    "@midwayjs/mock": "^4.0.0-beta.10",
+    "@midwayjs/validate": "^4.0.0-beta.10",
+    "swagger-ui-dist": "5.18.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -28,5 +30,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "1b1856629913703f67304155aaf611ec936a81ac"
 }