Midway Framework Documentation llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/midway/llms-txt) # Midway Framework Documentation llms.txt Browse Midway Framework Documentation documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. www.midwayjs.org/llms.txt [Raw llms.txt](https://www.midwayjs.org/llms.txt) [Raw llms-full.txt](https://www.midwayjs.org/llms-full.txt) Copy Markdown [](https://www.midwayjs.org/llms.txt) llms.txt blog Blog 历史博文 作者 core 和 decorator 包合并的影响 Jest v29 更新 mwtsc 增加版本检查 Blog Blog Blog Blog Blog Release 3.10.0 Release 3.11.0 Release 3.12.0 Release 3.13.0 Release 3.14.0 Release 3.15.0 Release 3.16.0 Release 3.17.0 Release 3.18.0 Release 3.19.0 Release 3.20.0 Release 3.6.0 Release 3.7.0 Release 3.8.0 Release 3.9.0 Release 4.0.0 Release 4.0.0-beta.1 Release 4.0.0-beta.10 Release 4.0.0-beta.2 Release 4.0.0-beta.9 移除 Node.js v14 的 CI 环境 移除 node v12 相关的依赖 新增 @midwayjs/skill-midway 标签 1 篇博文 含有标签「ai」 1 篇博文 含有标签「core」 1 篇博文 含有标签「decorator」 1 篇博文 含有标签「jest」 1 篇博文 含有标签「midway」 1 篇博文 含有标签「mwtsc」 2 篇博文 含有标签「node」 20 篇博文 含有标签「release」 20 篇博文 含有标签「release」 20 篇博文 含有标签「release」 20 篇博文 含有标签「release」 1 篇博文 含有标签「skill」 1 篇博文 含有标签「更新」 changelog Midway changelog 作者 Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog Midway changelog v0.2.10 v0.2.5 v0.2.6 v0.2.7 v0.2.8 v0.2.9 v0.4.5 v0.4.6 v0.4.7 v0.5.0 v0.5.1 v0.6.0 v0.6.1 v0.6.2 v0.6.3 v0.6.4 v0.6.5 v0.7.0 v0.7.1 v1.0.0 v1.0.1 v1.0.2 v1.0.3 v1.0.4 v1.0.5 v1.1.0 v1.1.1 v1.1.2 v1.10.0 v1.10.1 v1.10.2 v1.10.3 v1.10.4 v1.10.5 v1.10.6 v1.10.7 v1.10.8 v1.10.9 v1.11.0 v1.11.1 v1.11.2 v1.11.3 v1.11.4 v1.11.5 v1.11.6 v1.12.0 v1.12.1 v1.13.0 v1.14.0 v1.14.1 v1.14.2 v1.14.3 v1.14.4 v1.15.0 v1.15.1 v1.16.0 v1.16.1 v1.16.2 v1.16.3 v1.16.4 v1.17.0 v1.17.1 v1.2.0 v1.2.1 v1.2.2 v1.2.3 v1.2.4 v1.3.0 v1.3.1 v1.3.2 v1.4.0 v1.4.1 v1.4.10 v1.4.2 v1.4.3 v1.4.4 v1.4.5 v1.4.6 v1.4.7 v1.4.8 v1.4.9 v1.5.0 v1.5.1 v1.5.2 v1.5.3 v1.5.4 v1.5.5 v1.5.6 v1.6.0 v1.6.1 v1.6.2 v1.6.3 v1.7.0 v1.8.0 v1.9.0 v2.0.0 v2.0.1 v2.0.10 v2.0.11 v2.0.12 v2.0.13 v2.0.14 v2.0.15 v2.0.16 v2.0.17 v2.0.2 v2.0.3 v2.0.4 v2.0.5 v2.0.6 v2.0.7 v2.0.8 v2.0.9 v2.1.0 v2.1.1 v2.1.2 v2.1.3 v2.1.4 v2.10.0 v2.10.1 v2.10.10 v2.10.11 v2.10.12 v2.10.13 v2.10.14 v2.10.15 v2.10.16 v2.10.17 v2.10.18 v2.10.19 v2.10.2 v2.10.3 v2.10.4 v2.10.5 v2.10.6 v2.10.7 v2.10.8 v2.10.9 v2.11.0 v2.11.1 v2.11.2 v2.11.3 v2.11.4 v2.11.5 v2.11.6 v2.11.7 v2.12.0 v2.12.1 v2.12.2 v2.12.3 v2.12.4 v2.2.0 v2.2.1 v2.2.10 v2.2.2 v2.2.3 v2.2.4 v2.2.5 v2.2.6 v2.2.7 v2.2.8 v2.2.9 v2.3.0 v2.3.1 v2.3.10 v2.3.11 v2.3.12 v2.3.13 v2.3.14 v2.3.15 v2.3.16 v2.3.17 v2.3.18 v2.3.19 v2.3.2 v2.3.20 v2.3.21 v2.3.22 v2.3.23 v2.3.3 v2.3.4 v2.3.6 v2.3.7 v2.3.8 v2.3.9 v2.4.0 v2.4.1 v2.4.2 v2.4.3 v2.4.4 v2.4.5 v2.4.6 v2.4.7 v2.4.8 v2.5.0 v2.5.1 v2.5.2 v2.5.3 v2.5.4 v2.5.5 v2.6.0 v2.6.1 v2.6.10 v2.6.11 v2.6.12 v2.6.13 v2.6.2 v2.6.3 v2.6.4 v2.6.5 v2.6.6 v2.6.7 v2.6.8 v2.6.9 v2.7.0 v2.7.1 v2.7.2 v2.7.3 v2.7.4 v2.7.5 v2.7.6 v2.7.7 v2.8.0 v2.8.10 v2.8.11 v2.8.12 v2.8.13 v2.8.2 v2.8.3 v2.8.4 v2.8.5 v2.8.6 v2.8.7 v2.8.8 v2.8.9 v2.9.0 v2.9.1 v2.9.2 v2.9.3 v3.0.0 v3.0.1 v3.0.10 v3.0.11 v3.0.12 v3.0.13 v3.0.2 v3.0.3 v3.0.4 v3.0.5 v3.0.6 v3.0.7 v3.0.8 v3.0.9 v3.1.0 v3.1.1 v3.1.2 v3.1.3 v3.1.4 v3.1.5 v3.1.6 v3.10.0 v3.10.1 v3.10.10 v3.10.11 v3.10.12 v3.10.13 v3.10.14 v3.10.15 v3.10.16 v3.10.2 v3.10.3 v3.10.4 v3.10.5 v3.10.6 v3.10.7 v3.10.8 v3.10.9 v3.11.0 v3.11.1 v3.11.10 v3.11.11 v3.11.12 v3.11.13 v3.11.14 v3.11.15 v3.11.16 v3.11.17 v3.11.18 v3.11.2 v3.11.3 v3.11.4 v3.11.5 v3.11.6 v3.11.7 v3.11.8 v3.11.9 v3.12.0 v3.12.1 v3.12.10 v3.12.2 v3.12.3 v3.12.4 v3.12.5 v3.12.6 v3.12.7 v3.12.8 v3.12.9 v3.13.0 v3.13.1 v3.13.2 v3.13.3 v3.13.4 v3.13.5 v3.13.6 v3.13.7 v3.13.8 v3.13.9 v3.14.0 v3.14.1 v3.14.10 v3.14.11 v3.14.12 v3.14.13 v3.14.2 v3.14.3 v3.14.4 v3.14.5 v3.14.6 v3.14.7 v3.14.8 v3.14.9 v3.15.0 v3.15.1 v3.15.10 v3.15.11 v3.15.2 v3.15.3 v3.15.4 v3.15.5 v3.15.6 v3.15.7 v3.15.8 v3.15.9 v3.16.0 v3.16.1 v3.16.2 v3.16.3 v3.16.4 v3.16.5 v3.16.6 v3.16.7 v3.16.8 v3.17.0 v3.17.1 v3.17.2 v3.17.3 v3.18.0 v3.18.1 v3.18.2 v3.19.0 v3.19.1 v3.19.2 v3.19.3 v3.2.0 v3.2.1 v3.2.2 v3.20.0 v3.20.1 v3.20.10 v3.20.11 v3.20.12 v3.20.2 v3.20.3 v3.20.4 v3.20.5 v3.20.6 v3.20.7 v3.20.8 v3.20.9 v3.3.0 v3.3.1 v3.3.10 v3.3.11 v3.3.12 v3.3.13 v3.3.14 v3.3.2 v3.3.3 v3.3.4 v3.3.5 v3.3.6 v3.3.7 v3.3.8 v3.3.9 v3.4.0 v3.4.1 v3.4.10 v3.4.11 v3.4.12 v3.4.13 v3.4.2 v3.4.3 v3.4.4 v3.4.5 v3.4.6 v3.4.7 v3.4.8 v3.4.9 v3.5.0 v3.5.1 v3.5.2 v3.5.3 v3.6.0 v3.6.1 v3.7.0 v3.7.1 v3.7.2 v3.7.3 v3.7.4 v3.8.0 v3.8.1 v3.8.2 v3.8.3 v3.8.4 v3.9.0 v3.9.1 v3.9.2 v3.9.3 v3.9.4 v3.9.5 v3.9.6 v3.9.7 v3.9.8 v3.9.9 v4.0.0 v4.0.0-beta.1 v4.0.0-beta.10 v4.0.0-beta.11 v4.0.0-beta.12 v4.0.0-beta.13 v4.0.0-beta.14 v4.0.0-beta.15 v4.0.0-beta.16 v4.0.0-beta.17 v4.0.0-beta.2 v4.0.0-beta.3 v4.0.0-beta.4 v4.0.0-beta.5 v4.0.0-beta.6 v4.0.0-beta.7 v4.0.0-beta.8 v4.0.0-beta.9 v4.0.1 v4.0.2 v4.0.3 v4.1.0 v4.2.0 v4.2.1 index.layout 首页布局梳理（用于重设计） search 在文档中搜索 test-webcontainer WebContainer 组件测试 tutorials 🚧 教程中心 (开发中) 🚧 Class 语法教程 (开发中) 🚧 Function 语法教程 (开发中) api API API @midwayjs/async-hooks-context-manager AsyncHooksContextManager AsyncLocalStorageContextManager createContextManager isSemverGreaterThanOrEqualTo @midwayjs/axios Configuration HttpService HttpServiceFactory AxiosRequestConfig AxiosResponse @midwayjs/bootstrap abstractAbstractForkManager Bootstrap BootstrapStarter ClusterManager setupStickyMaster ForkOptions IForkManager @midwayjs/bull BullQueue Configuration Framework InjectQueue Processor Application Context IProcessor IQueue IQueueManager @midwayjs/bull-board BoardMiddleware BullBoardManager Configuration MidwayAdapter BullBoardOption @midwayjs/captcha CaptchaService Configuration CaptchaCacheOptions CaptchaOptions FormulaCaptchaOptions ImageCaptchaOptions TextCaptchaOptions @midwayjs/casbin AuthGuard abstractBaseAdapter CasbinEnforcerService Configuration AuthAction AuthActionVerb AuthPossession UsePermission CasbinConfigOptions Permission @midwayjs/casbin-redis-adapter abstractBaseWatcher NodeRedisAdapter NodeRedisWatcher createAdapter createWatcher @midwayjs/casbin-typeorm-adapter CasbinMongoRule CasbinRule TypeORMAdapter createAdapter @midwayjs/code-dye CodeDyeMW Configuration CodeDyeOptions @midwayjs/consul BalancerService Configuration ConsulController ConsulConfig IConsulBalancer IConsulProviderInfoOptions IConsulRegisterInfoOptions IServiceBalancer @midwayjs/core abstractAbstractFileDetector abstractBaseFramework CommonJSFileDetector ContextMiddlewareManager CustomModuleDetector abstractDataListener abstractDataSourceManager DecoratorManager DefaultConsoleLoggerFactory ESModuleFileDetector FilterManager abstractFrameworkType FunctionalConfiguration HttpClient HttpServerResponse abstractLoggerFactory MidwayApplicationManager MidwayAspectService MidwayCodeInvokeTimeoutError MidwayCommonError MidwayConfigMissingError MidwayConfigService MidwayContainer MidwayDecoratorService MidwayDefinitionNotFoundError MidwayDuplicateClassNameError MidwayDuplicateControllerOptionsError MidwayDuplicateRouteError MidwayEmptyValueError MidwayEnvironmentService MidwayError MidwayFeatureNoLongerSupportedError MidwayFeatureNotImplementedError MidwayFrameworkService MidwayFrameworkType MidwayHealthService MidwayHttpError MidwayInconsistentVersionError MidwayInformationService MidwayInvalidConfigError MidwayInvalidConfigPropertyError MidwayInvokeForbiddenError MidwayLifeCycleService MidwayLoggerService MidwayMainFrameworkMissingError MidwayMiddlewareService MidwayMissingImportComponentError MidwayMockService MidwayParameterError MidwayPerformanceManager MidwayPipelineService MidwayPriorityManager MidwayRequestContainer MidwayResolverMissingError MidwayRetryExceededMaxTimesError MidwayServerlessFunctionService MidwaySingletonInjectRequestError MidwayUseWrongMethodError MidwayUtilHttpClientTimeoutError MidwayWebRouterService PipelineContext ServerResponse abstractServiceFactory TypedResourceManager abstractWebControllerGenerator WebRouterCollector BaseType GrpcStreamTypeEnum HttpStatus InjectModeEnum MidwayProcessTypeEnum MSListenerType MSProviderType ObjectLifeCycleEvent RouteParamTypes ScopeEnum ServerlessTriggerType WSEventTypeEnum All App ApplicationContext Aspect attachClassMetadata attachPropertyDataToClass attachPropertyMetadata Autoload bindContainer Body Catch clearAllModule clearBindContainer Config Configuration Consumer ContentType Controller createConfiguration createCustomMethodDecorator createCustomParamDecorator createCustomPropertyDecorator createMiddleware createRender createRequestParamDecorator Del delegateTargetAllPrototypeMethod delegateTargetMethod delegateTargetProperties delegateTargetPrototypeMethod deprecatedOutput Destroy destroyGlobalApplicationContext DubboMethod Emit extend extractExpressLikeValue extractKoaLikeValue Fields File Files Framework Get getClassExtendedMetadata getClassMetadata getCurrentApplicationContext getCurrentAsyncContextManager getCurrentMainApp getCurrentMainFramework getMethodParamTypes getMethodReturnTypes getObjectDefinition getPropertyDataFromClass getPropertyInject getPropertyMetadata getPropertyType getProviderId getProviderName getProviderUUId GrpcMethod Guard Head Headers HSF HttpCode Init initializeGlobalApplicationContext Inject InjectClient isProvide isTypeScriptEnvironment KafkaListener listModule listPreloadModule listPropertyDataFromClass loadModule Logger makeHttpRequest Match Middleware Mock OnConnection OnDisConnection OnMessage OnWSConnection OnWSDisConnection OnWSMessage Options Param Patch pathMatching Pipe Pipeline Plugin Post prepareGlobalApplicationContext prepareGlobalApplicationContextAsync Provide Provider providerWrapper Put Queries Query Queue RabbitMQListener Redirect registerErrorCode RequestIP RequestMapping RequestPath resetModule retryWith retryWithAsync safelyGet safeRequire saveClassMetadata saveModule saveObjectDefinition savePreloadModule savePropertyDataToClass savePropertyInject savePropertyMetadata saveProviderId Schedule Scope ServerlessFunction ServerlessTrigger Session SetHeader Singleton sleep Task TaskLocal transformRequestObjectByType transformTypeFromTSDesign UseGuard wrapAsync wrapMiddleware WSBroadCast WSController WSEmit AspectMetadata AsyncContext AsyncContextManager CommonSchedule Context ControllerOption HealthResult HealthResults HSFOpts HttpClientOptions HttpClientResponse IComponentInfo IConfigService IConfigurationOptions IEnvironmentService IFileDetector IFilter IGuard IIdentifierRelationShip IInformationService ILifeCycle ILogger IManagedInstance IManagedResolver IManagedResolverFactoryCreateOptions IMethodAspect IMiddleware IMiddlewareManager IMidwayBaseApplication IMidwayBootstrapOptions IMidwayContainer IMidwayFramework IModuleStore InjectionConfigurationOptions IObjectCreator IObjectDefinition IObjectDefinitionRegistry IObjectFactory IObjectLifeCycle IPipelineContext IPipelineHandler IPipelineOptions IPipelineResult IProperties IServiceFactory ISimulation IValveHandler JoinPoint KafkaListenerOptions MethodDecoratorMetaData MethodDecoratorOptions MidwayAppInfo MidwayConfig MidwayCoreDefaultConfig MidwayLoggerOptions ObjectBeforeBindOptions ObjectBeforeCreatedOptions ObjectBeforeDestroyOptions ObjectCreatedOptions ObjectDefinitionOptions ObjectInitOptions ParamDecoratorOptions ParameterDecoratorMetaData PipeTransform RabbitMQListenerOptions ReflectResult ResolveFilter RouterCollectorOptions RouterInfo RouterOption RouterParamValue RouterPriority ScheduleOpts ServerSendEventMessage ServerSendEventStreamOptions ServerStreamOptions TagClsMetadata TagPropsMetadata TransformOptions TSDesignType WSControllerOption WSEventInfo ConsumerMetadata FaaSMetadata GRPCMetadata @midwayjs/cos Configuration COSService COSServiceFactory @midwayjs/cron Configuration Framework InjectJob Job Application Context CronOptions IJob @midwayjs/cross-domain Configuration CorsMiddleware JSONPFilter JSONPMiddleware JSONPService CORSOptions JSONPOptions @midwayjs/decorator DecoratorManager abstractFrameworkType MidwayFrameworkType BaseType GrpcStreamTypeEnum InjectModeEnum MSListenerType MSProviderType RouteParamTypes ScopeEnum ServerlessTriggerType WSEventTypeEnum All App ApplicationContext Aspect attachClassMetadata attachPropertyDataToClass attachPropertyMetadata Autoload bindContainer Body Catch clearAllModule clearBindContainer Config Configuration Consumer ContentType Controller createCustomMethodDecorator createCustomParamDecorator createCustomPropertyDecorator createRender createRequestParamDecorator Del Destroy DubboMethod Emit Fields File Files Framework Get getClassExtendedMetadata getClassMetadata getMethodParamTypes getMethodReturnTypes getObjectDefinition getPropertyDataFromClass getPropertyInject getPropertyMetadata getPropertyType getProviderId getProviderName getProviderUUId GrpcMethod Guard Head Headers HSF HttpCode Init Inject InjectClient isProvide KafkaListener listModule listPreloadModule listPropertyDataFromClass Logger Match Middleware Mock OnConnection OnDisConnection OnMessage OnWSConnection OnWSDisConnection OnWSMessage Options Param Patch Pipe Pipeline Plugin Post Provide Provider Put Queries Query Queue RabbitMQListener Redirect RequestIP RequestMapping RequestPath resetModule saveClassMetadata saveModule saveObjectDefinition savePreloadModule savePropertyDataToClass savePropertyInject savePropertyMetadata saveProviderId Schedule Scope ServerlessFunction ServerlessTrigger Session SetHeader Singleton sleep Task TaskLocal transformTypeFromTSDesign UseGuard WSBroadCast WSController WSEmit CommonSchedule ControllerOption HSFOpts IComponentInfo IManagedInstance IMethodAspect IModuleStore InjectionConfigurationOptions JoinPoint KafkaListenerOptions ObjectDefinitionOptions RabbitMQListenerOptions ReflectResult ResolveFilter RouterOption RouterParamValue ScheduleOpts TagClsMetadata TagPropsMetadata WSControllerOption WSEventInfo ConsumerMetadata FaaSMetadata GRPCMetadata @midwayjs/etcd Configuration ETCDService ETCDServiceFactory @midwayjs/express-session Configuration SessionMiddleware SessionStoreManager @midwayjs/faas abstractAbstractBootstrapStarter Configuration Framework Event Application Context FaaSContext FaaSHTTPContext FaaSHTTPRequest FaaSHTTPResponse FormatResponseOptions HandlerOptions HttpResponseFormat IFaaSConfigurationOptions IWebMiddleware ServerlessStarterOptions State wrapHttpRequestOptions @midwayjs/grpc Clients Configuration Framework createGRPCConsumer loadProto Context DefaultConfig IClientDuplexStreamService IClientOptions IClientReadableStreamService IClientUnaryService IClientWritableStreamService IGRPCClientServiceOptions IGRPCServiceOptions IMidwayGRPFrameworkOptions @midwayjs/http-proxy Configuration HttpProxyMiddleware HttpProxyConfig HttpProxyStrategy @midwayjs/i18n Configuration I18nFilter I18nMiddleware MidwayI18nService MidwayI18nServiceSingleton formatLocale I18nOptions RequestResolver TranslateOptions @midwayjs/info Configuration InfoMiddleware InfoService InfoType InfoConfigOptions TypeInfo @midwayjs/jwt Configuration https://github.com/auth0/node-jsonwebtoken @midwayjs/kafka Configuration Framework KafkaAdminFactory KafkaProducerFactory KafkaConsumer Context IKafkaApplication IKafkaConsumer IKafkaConsumerInitOptions IMidwayConsumerConfig IMidwayKafkaAdminInitOptions IMidwayKafkaConfigurationOptions IMidwayKafkaProducerInitOptions @midwayjs/mikro Configuration MikroDataSourceManager InjectDataSource InjectEntityManager InjectRepository @midwayjs/mock SocketIOWrapperClient close create createApp createBootstrap createFunctionApp createHttpRequest createKafkaProducer createLightApp createRabbitMQProducer createSocketIOClient createWebSocketClient mockClassProperty mockContext mockHeader mockProperty mockSession processArgsParser restoreAllMocks restoreMocks transformFrameworkToConfiguration MidwaySocketIOClientOptions @midwayjs/mongoose Configuration MongooseConnectionService MongooseConnectionServiceFactory MongooseDataSourceManager @midwayjs/otel Configuration TraceService Trace @midwayjs/passport abstractAbstractPassportMiddleware Configuration PassportAuthenticator CustomStrategy PassportMiddleware PassportStrategy AuthenticateOptions IPassportMiddleware IPassportStrategy StrategyCreatedStatic @midwayjs/process-agent Configuration RunInPrimary @midwayjs/prometheus Configuration DataService @midwayjs/prometheus-socket-io Configuration @midwayjs/rabbitmq Configuration Framework Context IMidwayRabbitMQConfigurationOptions IRabbitMQApplication IRabbitMQExchange @midwayjs/redis Configuration RedisService RedisServiceFactory @midwayjs/security Configuration CSPMiddleware CsrfMiddleware HSTSMiddleware NoOpenMiddleware NoSniffMiddleware SecurityHelper XFrameMiddleware XSSProtectionMiddleware SecurityCSPOptions SecurityCSRFOptions SecurityEnableOptions SecurityHSTSOptions SecurityOptions SecurityXFrameOptions SecurityXSSProtectionOptions @midwayjs/sequelize Configuration SequelizeDataSourceManager BaseTable InjectDataSource InjectRepository @midwayjs/session Configuration SessionMiddleware abstractSessionStore SessionStoreManager ISession SessionOptions @midwayjs/socketio Configuration Framework createRedisAdapter @midwayjs/static-file Configuration DirectoryNotFoundError StaticMiddleware StaticFileOption StaticFileOptions @midwayjs/swagger Configuration SwaggerExplorer SwaggerMiddleware BodyContentType ApiAcceptedResponse ApiBadGatewayResponse ApiBadRequestResponse ApiBasicAuth ApiBearerAuth ApiBody ApiConflictResponse ApiCookieAuth ApiCreatedResponse ApiDefaultResponse ApiExcludeController ApiExcludeEndpoint ApiExcludeSecurity ApiExtension ApiExtraModel ApiForbiddenResponse ApiFoundResponse ApiGatewayTimeoutResponse ApiGoneResponse ApiHeader ApiHeaders ApiInternalServerErrorResponse ApiMethodNotAllowedResponse ApiMovedPermanentlyResponse ApiNoContentResponse ApiNotAcceptableResponse ApiNotFoundResponse ApiNotImplementedResponse ApiOAuth2 ApiOkResponse ApiOperation ApiParam ApiPayloadTooLargeResponse ApiPreconditionFailedResponse ApiProperty ApiPropertyOptional ApiQuery ApiRequestTimeoutResponse ApiResponse ApiResponseProperty ApiSecurity ApiServiceUnavailableResponse ApiTags ApiTooManyRequestsResponse ApiUnauthorizedResponse ApiUnprocessableEntityResponse ApiUnsupportedMediaTypeResponse getSchemaPath renderJSON renderSwaggerUIDist renderSwaggerUIRemote ApiHeaderOptions ApiPropertyOptions ApiResponseMetadata ApiResponseSchemaHost https://swagger.io/specification/#security-scheme-object BaseParameterObject ComponentsObject ContactObject DiscriminatorObject EncodingPropertyObject ExampleObject ExternalDocumentationObject InfoObject LicenseObject LinkObject MediaTypeObject MixDecoratorMetadata OAuthFlowObject OAuthFlowsObject OpenAPIObject OperationObject ParameterObject PathItemObject ReferenceObject RequestBodyObject ResponseObject ResponsesObject SchemaObject SchemaObjectMetadata SecuritySchemeObject ServerObject ServerVariableObject https://swagger.io/specification/ TagObject Type XmlObject @midwayjs/tablestore CompositeCondition Condition Configuration SingleColumnCondition TableStoreService TableStoreServiceFactory ColumnConditionType ColumnReturnType ComparatorType DefinedColumnType Direction FieldType FilterType GeoDistanceType IndexOptions IndexType IndexUpdateMode LogicalOperator PrimaryKeyOption PrimaryKeyType QueryOperator QueryType ReturnType RowExistenceExpectation ScoreMode SortMode SortOrder UpdateType formatRow formatRows BatchGetRowParams BatchWriteRowParams ColumnCondition CreateIndexParams CreateSearchIndexParams CreateTableParams DeleteRowParams DeleteSearchIndexParams DeleteTableParams DescribeSearchIndexParams DescribeTableParams DropIndexParams GetRangeParams GetRowParams ListSearchIndexParams PutRowParams SearchIndexFieldSchema SearchIndexNestedFilter SearchIndexSchema SearchIndexSetting SearchIndexSorter SearchParams SearchQuery StartLocalTransactionParams TableStoreClient TableStoreCompositeCondition TableStoreCondition TableStoreConfig TableStoreLong TableStoreResult TableStoreSingleColumnCondition UpdateRowParams UpdateTableParams @midwayjs/tags Configuration abstractITagDialect abstractITagDialectInstance TagClient TagServiceFactory MATCH_TYPE TAG_ERROR ITagBindOptions ITagDefine ITagInstance ITagItem ITagListInstanceOptions ITagListInstanceTagsOptions ITagListResult ITagMysqlDialectOption ITagOperResult ITagPages ITagSearchOptions ITagServiceInitOptions ITagUnBindOptions ITagUserDialect @midwayjs/typegoose Configuration EntityModel InjectEntityModel @midwayjs/typeorm Configuration TypeORMDataSourceManager EventSubscriberModel InjectDataSource InjectEntityModel @midwayjs/upload Configuration MultipartInvalidFilenameError MultipartInvalidFileTypeError UploadMiddleware UploadFileInfo UploadOptions @midwayjs/validate abstractAbstractValidationPipe Configuration DecoratorValidPipe DefaultValuePipe MidwayValidationError ParseBoolPipe ParseFloatPipe ParseIntPipe abstractParsePipe ValidateService ValidationPipe getSchema OmitDto PickDto Rule Valid Validate Dto RuleOptions ValidateOptions @midwayjs/view Configuration ContextView ViewManager IViewEngine RenderOptions @midwayjs/view-ejs Configuration EjsView @midwayjs/view-nunjucks Configuration NunjucksEnvironment NunjucksView @midwayjs/web Agent Application Configuration Framework AgentApp createAgentWorkerLoader createAppWorkerLoader createEggAgent createEggApplication RunInEggAgent startCluster Context IMidwayWebBaseApplication IMidwayWebConfigurationOptions IWebMiddleware State @midwayjs/express Configuration Framework MidwayExpressMiddlewareService wrapAsyncHandler wrapMiddleware Context IMidwayExpressApplication IMidwayExpressConfigurationOptions @midwayjs/koa BodyParserMiddleware Configuration Framework SiteFileMiddleware BodyParserOptions Context IMidwayKoaConfigurationOptions IWebMiddleware State @midwayjs/ws Configuration Framework Context @midwayjs/axios Configuration HttpService HttpServiceFactory AxiosRequestConfig AxiosResponse @midwayjs/bootstrap abstractAbstractForkManager Bootstrap BootstrapStarter ClusterManager setupStickyMaster ForkOptions IForkManager @midwayjs/bull BullQueue Configuration Framework InjectQueue Processor Application Context IProcessor IQueue IQueueManager @midwayjs/bull-board BoardMiddleware BullBoardManager Configuration MidwayAdapter BullBoardOption @midwayjs/bullmq BullMQQueue Configuration Framework InjectFlowProducer InjectQueue InjectWorker Processor Application BullMQConfig Context IProcessor @midwayjs/busboy Configuration MultipartError MultipartFieldsLimitError MultipartFileLimitError MultipartFileSizeLimitError MultipartInvalidFilenameError MultipartInvalidFileTypeError MultipartPartsLimitError UploadMiddleware UploadFileInfo UploadOptions UploadStreamFieldInfo UploadStreamFileInfo @midwayjs/cache-manager CachingFactory Configuration Caching createRedisStore getClassMethodDefaultCacheKey RedisStore CacheManager @midwayjs/captcha CaptchaService Configuration CaptchaCacheOptions CaptchaOptions FormulaCaptchaOptions ImageCaptchaOptions TextCaptchaOptions @midwayjs/casbin AuthGuard abstractBaseAdapter CasbinEnforcerService Configuration AuthAction AuthActionVerb AuthPossession UsePermission CasbinConfigOptions Permission @midwayjs/casbin-redis-adapter abstractBaseWatcher NodeRedisAdapter NodeRedisWatcher createAdapter createWatcher @midwayjs/casbin-typeorm-adapter CasbinMongoRule CasbinRule TypeORMAdapter createAdapter @midwayjs/code-dye CodeDyeMW Configuration CodeDyeOptions @midwayjs/consul Configuration ConsulService ConsulServiceDiscoverClient ConsulServiceDiscovery ConsulServiceFactory ConsulHealthItem ConsulInstanceMetadata ConsulServiceDiscoveryOptions @midwayjs/core abstractAbstractFileDetector abstractBaseFramework CommonJSFileDetector ContextMiddlewareManager CustomModuleDetector abstractDataListener abstractDataSourceManager DecoratorManager DefaultConsoleLoggerFactory DynamicMidwayContainer ESModuleFileDetector FilterManager HttpClient HttpServerResponse LoadBalancerFactory abstractLoggerFactory MetadataManager MidwayApplicationManager MidwayAspectService MidwayCodeInvokeTimeoutError MidwayCommonError MidwayConfigMissingError MidwayConfigService MidwayContainer MidwayDecoratorService MidwayDefinitionNotFoundError MidwayDuplicateClassNameError MidwayDuplicateControllerOptionsError MidwayDuplicateRouteError MidwayEmptyValueError MidwayEnvironmentService MidwayError MidwayFeatureNoLongerSupportedError MidwayFeatureNotImplementedError MidwayFrameworkService MidwayHealthService MidwayHttpError MidwayInconsistentVersionError MidwayInformationService MidwayInvalidConfigError MidwayInvalidConfigPropertyError MidwayInvokeForbiddenError MidwayLifeCycleService MidwayLoggerService MidwayMainFrameworkMissingError MidwayMiddlewareService MidwayMissingImportComponentError MidwayMockService MidwayParameterError MidwayPerformanceManager MidwayPriorityManager MidwayRequestContainer MidwayRetryExceededMaxTimesError MidwayServerlessFunctionService MidwaySingletonInjectRequestError MidwayTraceService MidwayUseWrongMethodError MidwayUtilHttpClientTimeoutError MidwayWebRouterService RandomLoadBalance RoundRobinLoadBalancer ServerResponse abstractServiceDiscovery abstractServiceDiscoveryClient abstractServiceFactory TypedResourceManager abstractWebControllerGenerator GrpcStreamTypeEnum HttpStatus InjectModeEnum MidwayProcessTypeEnum MSListenerType MSProviderType ObjectLifeCycleEvent RouteParamTypes ScopeEnum ServerlessTriggerType WSEventTypeEnum All AllConfig App ApplicationContext Aspect attachClassMetadata attachPropertyDataToClass attachPropertyMetadata Autoload Body Catch clearAllModule Config Configuration Consumer ContentType Controller createCustomMethodDecorator createCustomParamDecorator createCustomPropertyDecorator createMiddleware createRender createRequestParamDecorator Del delegateTargetAllPrototypeMethod delegateTargetMethod delegateTargetProperties delegateTargetPrototypeMethod deprecatedOutput Destroy destroyGlobalApplicationContext DubboMethod Emit extend extractExpressLikeValue extractKoaLikeValue Fields File Files Framework Get getClassExtendedMetadata getClassMetadata getCurrentApplicationContext getCurrentAsyncContextManager getCurrentMainApp getCurrentMainFramework getMethodParamTypes getObjectDefinition getPropertyDataFromClass getPropertyInject getPropertyMetadata getPropertyType getProviderId getProviderName getProviderUUId GrpcMethod Guard Head Headers HttpCode Init initializeGlobalApplicationContext Inject InjectClient isProvide isTypeScriptEnvironment KafkaListener LazyInject listModule listPreloadModule listPropertyDataFromClass loadModule Logger MainApp makeHttpRequest Match Middleware Mock OnConnection OnDisConnection OnMessage OnWSConnection OnWSDisConnection OnWSMessage Options Param Patch pathMatching Pipe Plugin Post prepareGlobalApplicationContext prepareGlobalApplicationContextAsync Provide Provider providerWrapper Put Queries Query Queue RabbitMQListener Redirect registerErrorCode RequestIP RequestMapping RequestPath resetModule retryWith retryWithAsync safelyGet safeRequire saveClassMetadata saveModule saveObjectDefinition savePreloadModule savePropertyDataToClass savePropertyInject savePropertyMetadata saveProviderId Schedule Scope ServerlessFunction ServerlessTrigger Session SetHeader Singleton sleep Task TaskLocal Trace transformRequestObjectByType UseGuard wrapAsync wrapMiddleware WSBroadCast WSController WSEmit AspectMetadata AsyncContext AsyncContextManager BaseServiceDiscoveryHealthCheckOptions CommonSchedule ConstructorInjectMetadata Context ControllerOption DataSourceManagerConfigOption DefaultInstanceMetadata DuplicateRouteErrorEntry DuplicateRouteErrorPayload HealthResult HealthResults HttpClientOptions HttpClientResponse HTTPServiceDiscoveryHealthCheckOptions IComponentInfo IConfigService IConfigurationOptions IDataSourceManager IEnvironmentService IFileDetector IFilter IGuard IIdentifierRelationShip IInformationService ILifeCycle ILoadBalancer ILogger IMethodAspect IMiddleware IMiddlewareManager IMidwayBaseApplication IMidwayBootstrapOptions IMidwayContainer IMidwayFramework IMidwayGlobalContainer IMidwayRequestContainer InjectionConfigurationOptions IObjectCreator IObjectDefinition IObjectDefinitionRegistry IObjectFactory IObjectLifeCycle IServiceDiscoveryClient IServiceDiscoveryHealthCheck IServiceFactory ISimulation JoinPoint KafkaListenerOptions LifeCycleInvokeOptions MethodDecoratorMetaData MethodDecoratorOptions MidwayAppInfo MidwayConfig MidwayCoreDefaultConfig MidwayLoggerOptions ModuleLoadOptions ObjectBeforeBindOptions ObjectBeforeCreatedOptions ObjectBeforeDestroyOptions ObjectCreatedOptions ObjectDefinitionOptions ObjectInitOptions ParamDecoratorOptions ParameterDecoratorMetaData PipeTransform PropertyDecoratorOptions PropertyInjectMetadata RabbitMQListenerOptions ReflectResult RouterCollectorOptions RouterInfo RouterOption RouterParamValue RouterPriority ScheduleOpts ServerSendEventForwardOptions ServerSendEventMessage ServerSendEventStreamOptions ServerStreamOptions ServiceDiscoveryBaseInstance ServiceDiscoveryHealthCheckResult ServiceDiscoveryOptions TagClsMetadata TagPropsMetadata TCPServiceDiscoveryHealthCheckOptions TraceMetaResolverArgs TransformOptions TSDesignType TTLServiceDiscoveryHealthCheckOptions WSControllerOption WSEventInfo ConsumerMetadata FaaSMetadata GRPCMetadata @midwayjs/cos Configuration COSService COSServiceFactory @midwayjs/cron Configuration Framework InjectJob Job Application Context CronOptions IJob @midwayjs/cross-domain Configuration CorsMiddleware JSONPFilter JSONPMiddleware JSONPService CORSOptions JSONPOptions @midwayjs/etcd Configuration ETCDService EtcdServiceDiscoverClient EtcdServiceDiscovery ETCDServiceFactory @midwayjs/event-emitter Configuration EventEmitterService OnEvent EventEmitterConfigOptions @midwayjs/express-session Configuration SessionMiddleware SessionStoreManager @midwayjs/faas abstractAbstractBootstrapStarter Configuration Framework Event Application Context FaaSContext FaaSHTTPContext FaaSHTTPRequest FaaSHTTPResponse FormatResponseOptions HandlerOptions HttpResponseFormat IFaaSConfigurationOptions IWebMiddleware ServerlessStarterOptions State wrapHttpRequestOptions @midwayjs/grpc Clients Configuration Framework createGRPCConsumer loadProto Context DefaultConfig IClientDuplexStreamService IClientOptions IClientReadableStreamService IClientUnaryService IClientWritableStreamService IGRPCClientServiceOptions IGRPCServiceOptions IMidwayGRPFrameworkOptions @midwayjs/http-proxy Configuration HttpProxyMiddleware HttpProxyConfig HttpProxyStrategy @midwayjs/i18n Configuration I18nFilter I18nMiddleware MidwayI18nService MidwayI18nServiceSingleton formatLocale I18nOptions RequestResolver TranslateOptions @midwayjs/info Configuration InfoMiddleware InfoService InfoType InfoConfigOptions TypeInfo @midwayjs/jwt Configuration https://github.com/auth0/node-jsonwebtoken @midwayjs/kafka Configuration Framework KafkaAdminFactory KafkaProducerFactory KafkaConsumer Context IKafkaApplication IKafkaConsumer IKafkaConsumerInitOptions IMidwayConsumerConfig IMidwayKafkaAdminInitOptions IMidwayKafkaConfigurationOptions IMidwayKafkaProducerInitOptions @midwayjs/leoric Configuration LeoricDataSourceManager InjectDataSource InjectModel @midwayjs/mcp Configuration MCPAuthInfoMiddleware MidwayMCPFramework Prompt Resource Tool Context IMcpPrompt IMcpResource IMcpTool IMidwayMCPConfigurationOptions IMidwayMCPContext @midwayjs/mikro Configuration MikroDataSourceManager InjectDataSource InjectEntityManager InjectRepository @midwayjs/mock SocketIOWrapperClient SSEClient close create createApp createBootstrap createFunctionApp createHttpRequest createKafkaProducer createLegacyApp createLegacyFunctionApp createLegacyLightApp createLightApp createRabbitMQProducer createSocketIOClient createSSEClient createWebSocketClient mockClassProperty mockContext mockHeader mockProperty mockSession processArgsParser restoreAllMocks restoreMocks transformFrameworkToConfiguration MidwaySocketIOClientOptions SSEClientOptions @midwayjs/mongoose Configuration MongooseConnectionService MongooseConnectionServiceFactory MongooseDataSourceManager @midwayjs/mqtt Configuration DefaultMqttProducer Framework MqttProducerFactory MqttSubscriber Context IMidwayMQTTConfigurationOptions IMqttSubscriber MqttSubscriberOptions @midwayjs/nextjs Configuration NextJSMiddleware createClient createNextjsApiClient createNextjsApiClientFromOperations resolveNextjsApiBridgeOptions @midwayjs/oss Configuration OSSService OSSServiceFactory OSSSTSService MWOSSClusterOptions MWOSSOptions MWOSSSTSOptions @midwayjs/passport abstractAbstractPassportMiddleware Configuration PassportAuthenticator CustomStrategy PassportMiddleware PassportStrategy AuthenticateOptions IPassportMiddleware IPassportStrategy StrategyCreatedStatic @midwayjs/prometheus Configuration DataService @midwayjs/prometheus-socket-io Configuration @midwayjs/rabbitmq Configuration Framework Context IMidwayRabbitMQConfigurationOptions IRabbitMQApplication IRabbitMQExchange @midwayjs/redis Configuration RedisService RedisServiceDiscoverClient RedisServiceDiscovery RedisServiceFactory RedisInstanceMetadata RedisServiceDiscoveryOptions @midwayjs/security Configuration CSPMiddleware CsrfMiddleware HSTSMiddleware NoOpenMiddleware NoSniffMiddleware SecurityHelper XFrameMiddleware XSSProtectionMiddleware SecurityCSPOptions SecurityCSRFOptions SecurityEnableOptions SecurityHSTSOptions SecurityOptions SecurityXFrameOptions SecurityXSSProtectionOptions @midwayjs/sequelize Configuration SequelizeDataSourceManager InjectDataSource InjectRepository @midwayjs/session Configuration SessionMiddleware abstractSessionStore SessionStoreManager ISession SessionOptions @midwayjs/socketio Configuration Framework @midwayjs/static-file Configuration DirectoryNotFoundError StaticMiddleware StaticFileOption StaticFileOptions @midwayjs/swagger Configuration SwaggerExplorer SwaggerMiddleware BodyContentType ApiAcceptedResponse ApiBadGatewayResponse ApiBadRequestResponse ApiBasicAuth ApiBearerAuth ApiBody ApiConflictResponse ApiCookieAuth ApiCreatedResponse ApiDefaultResponse ApiExcludeController ApiExcludeEndpoint ApiExcludeSecurity ApiExtension ApiExtraModel ApiForbiddenResponse ApiFoundResponse ApiGatewayTimeoutResponse ApiGoneResponse ApiHeader ApiHeaders ApiInternalServerErrorResponse ApiMethodNotAllowedResponse ApiMovedPermanentlyResponse ApiNoContentResponse ApiNotAcceptableResponse ApiNotFoundResponse ApiNotImplementedResponse ApiOAuth2 ApiOkResponse ApiOperation ApiParam ApiPayloadTooLargeResponse ApiPreconditionFailedResponse ApiProperty ApiPropertyOptional ApiQuery ApiRequestTimeoutResponse ApiResponse ApiResponseProperty ApiSecurity ApiServiceUnavailableResponse ApiTags ApiTooManyRequestsResponse ApiUnauthorizedResponse ApiUnprocessableEntityResponse ApiUnsupportedMediaTypeResponse getSchemaPath renderJSON renderSwaggerUIDist renderSwaggerUIRemote ApiHeaderOptions ApiPropertyOptions ApiResponseMetadata ApiResponseSchemaHost https://swagger.io/specification/#security-scheme-object BaseParameterObject ComponentsObject ContactObject DiscriminatorObject EncodingPropertyObject ExampleObject ExternalDocumentationObject InfoObject LicenseObject LinkObject MediaTypeObject MixDecoratorMetadata OAuthFlowObject OAuthFlowsObject OpenAPIObject OperationObject ParameterObject PathItemObject ReferenceObject RequestBodyObject ResponseObject ResponsesObject SchemaObject SchemaObjectMetadata SecuritySchemeObject ServerObject ServerVariableObject https://swagger.io/specification/ TagObject Type XmlObject @midwayjs/tablestore CompositeCondition Condition Configuration SingleColumnCondition TableStoreService TableStoreServiceFactory ColumnConditionType ColumnReturnType ComparatorType DefinedColumnType Direction FieldType FilterType GeoDistanceType IndexOptions IndexType IndexUpdateMode LogicalOperator PrimaryKeyOption PrimaryKeyType QueryOperator QueryType ReturnType RowExistenceExpectation ScoreMode SortMode SortOrder UpdateType formatRow formatRows BatchGetRowParams BatchWriteRowParams ColumnCondition CreateIndexParams CreateSearchIndexParams CreateTableParams DeleteRowParams DeleteSearchIndexParams DeleteTableParams DescribeSearchIndexParams DescribeTableParams DropIndexParams GetRangeParams GetRowParams ListSearchIndexParams PutRowParams SearchIndexFieldSchema SearchIndexNestedFilter SearchIndexSchema SearchIndexSetting SearchIndexSorter SearchParams SearchQuery StartLocalTransactionParams TableStoreClient TableStoreCompositeCondition TableStoreCondition TableStoreConfig TableStoreLong TableStoreResult TableStoreSingleColumnCondition UpdateRowParams UpdateTableParams @midwayjs/tenant Configuration TenantManager @midwayjs/typegoose Configuration EntityModel InjectEntityModel @midwayjs/typeorm Configuration TypeORMDataSourceManager EventSubscriberModel InjectDataSource InjectEntityModel @midwayjs/upload Configuration MultipartInvalidFilenameError MultipartInvalidFileTypeError UploadMiddleware UploadFileInfo UploadOptions @midwayjs/validate abstractAbstractValidationPipe Configuration DecoratorValidPipe DefaultValuePipe MidwayValidationError ParseBoolPipe ParseFloatPipe ParseIntPipe abstractParsePipe ValidateService ValidationPipe getSchema OmitDto PickDto Rule Valid Validate Dto ValidateOptions @midwayjs/validation abstractAbstractValidationPipe Configuration DecoratorValidPipe DefaultValuePipe MidwayValidationError MidwayValidatorNotFoundError ParseBoolPipe ParseFloatPipe ParseIntPipe abstractParsePipe ValidationPipe ValidationService getRuleMeta getSchema OmitDto PartialDto PickDto RequiredDto Rule Valid Validate Dto IValidationService IValidator IValidatorModule SchemaHelper ValidateResult ValidationDecoratorOptions ValidationExtendOptions ValidationOptions @midwayjs/validation-class-validator ClassValidatorService @midwayjs/validation-joi @midwayjs/validation-zod @midwayjs/view Configuration ContextView ViewManager IViewEngine RenderOptions @midwayjs/view-ejs Configuration EjsView @midwayjs/view-nunjucks Configuration NunjucksEnvironment NunjucksView @midwayjs/web Agent Application Configuration Framework AgentApp createAgentWorkerLoader createAppWorkerLoader createEggAgent createEggApplication RunInEggAgent startCluster Context IMidwayWebBaseApplication IMidwayWebConfigurationOptions IWebMiddleware State @midwayjs/express Configuration Framework MidwayExpressMiddlewareService wrapAsyncHandler wrapMiddleware Context IMidwayExpressApplication IMidwayExpressConfigurationOptions @midwayjs/koa BodyParserMiddleware Configuration Framework SiteFileMiddleware BodyParserOptions Context IMidwayKoaConfigurationOptions IWebMiddleware State @midwayjs/ws Configuration Framework Context docs 路由和控制器 Debug 高级装饰器 API 部署 Docker 中进程过多 介绍 框架增强 介绍 依赖注入手册 基础介绍 全局中间件 快速上手 介绍 应用测试 midway 高级测试方案 midway 工具集 TS 新手指南 接入 Alinode 方法拦截器（切面） BodyParser 使用 cfork 修改源码目录 组件开发 依赖注入 扩展上下文定义 控制器（Controller） Cookies 跨域 CORS 自定义 EggJS 框架接入 本地调试 高级装饰器 API 现有装饰器索引 启动和部署 EggJS 多环境配置 运行环境 Express HTTP 请求（Axios） 缓存（Cache） Consul 对象存储（COS） GraphQL gRPC MongoDB Database（TypeORM) 对象存储（OSS） Passport 进程共享（ProcessAgent） RabbitMQ Redis 模板渲染 Sequelize Swagger TableStore 任务调度（Task） FaaS 文件上传 框架扩展 常见框架错误 常见 git 问题 非 Serverless 环境使用一体化 接口开发 & 前端调用 纯接口项目增加 Hooks 支持 内置 Hooks 运行时配置 & Hooks 组件 项目初始化 自定义前端 SDK 本地调试 Web 中间件 小程序一体化 路由 Hooks 语法 介绍 OSS 文件上传 如何安装 Node.js 环境 如何更新 Midway 介绍 Koa 生命周期 日志 使用组件 关于 Midway 启动慢的问题 多框架研发 常见 npm 问题 代码流程控制 使用 pm2 接入 Prometheus Midway 维护计划 请求、响应、应用 Web 路由表 示例列表 API 网关 事件触发器（Event） HTTP 触发器 MNS 触发器（消息队列） OSS 触发器（对象存储） Timer 触发器（定时任务） 应用迁移方案说明 阿里云发布 FAQ 腾讯云发布 FAQ 发布到阿里云 FC 发布到腾讯云 SCF Egg/Midway 应用迁移 Express 应用迁移 应用迁移 FAQ Koa 应用迁移 静态网站托管 聚合部署 函数上下文 开发函数 部署环境 默认错误行为 介绍 Serverless 触发器 POST 情况差异 测试函数 Serverless 函数部署为应用 从 Serverless v1 迁移到 v2 f.yml 定义 API 网关（HTTP） CMQ 触发器（消息队列） COS 触发器（对象存储） Timer 触发器（定时任务） 服务和注入 服务工厂 Session SocketIO 创建第一个应用 静态资源（Static File） 测试 midwayjs/cli midwayjs/egg-ts-helper 检查工具 Lint 工具、规则和格式化 TypeORM Model Generator 常见 TS 问题 从 Midway v1 升级到 v2 参数校验和转换 Web 中间件 WebSocket 拦截器（AOP） 自执行代码 Awesome Midway 内置服务 修改源码目录 自定义组件 依赖注入 扩展上下文定义 向 Midway 贡献 路由和控制器 Cookies 和 Session 自定义数据响应 自定义装饰器 自定义错误 数据订阅 数据响应 数据源管理 调试 现有装饰器索引 启动和部署 多环境配置 运行环境 框架错误码 异常处理 ESModule 使用指南 Alinode HTTP 请求 任务队列 任务队列 文件上传 缓存 缓存 验证码 角色鉴权 cfork 代码染色 Consul 腾讯云对象存储（COS） 本地任务 跨域 EggJS ETCD Express gRPC HTTP 代理 多语言 信息查看 JWT Kafka Koa MikroORM MongoDB MQTT TypeORM 阿里云对象存储（OSS） 链路追踪 身份验证 pm2 进程 Agent Prometheus RabbitMQ Redis 模板渲染 安全 Sequelize SocketIO 静态文件托管 Swagger TableStore 标签组件 租户 文件上传 参数校验 WebSocket 关于 Alias Path 常见框架问题 常见 git 问题 常见 npm 问题 常见 TS 问题 守卫 接口开发 Hooks 前端请求客户端 使用 Midway 组件 项目配置 跨域 CORS 调试 部署 简易模式 & 文件系统路由 全栈套件 介绍 Web 中间件 Prisma ORM 静态类型安全 + 运行时安全 测试 文件上传 参数校验 如何安装 Node.js 环境 如何更新 Midway 介绍 MongoDB TypeORM Sequelize 任务调度 生命周期 日志（v2） 日志 Web 中间件 使用组件 关于 Midway 启动慢的问题 数据模拟 服务器启动失败排查 管道 流程控制 快速入门 创建第一个应用 Midway 维护计划 Application 和 Context 重试机制 Web 路由表 部署到阿里云函数计算 部署到 AWS Lambda 函数上下文 开发函数 默认错误行为 介绍 Serverless 触发器 POST 情况差异 测试函数 从 Serverless v2 迁移到 v3 服务和注入 服务工厂 测试 Midway CLI 脚手架 egg:ts-helper 规则检查工具 Lint 和格式化 开发工具 sequelize-auto-midway typeorm:Model Generator 版本检查工具 2.x 升级指南 拦截器（AOP） 自执行代码 Awesome Midway 内置服务 修改源码目录 自定义组件 依赖注入 扩展上下文定义 向 Midway 贡献 路由和控制器 Cookies 和 Session 自定义数据响应 自定义装饰器 自定义错误 数据订阅 数据响应 数据源管理 调试 现有装饰器索引 启动和部署 多环境配置 运行环境 框架错误码 异常处理 ESModule 使用指南 Alinode Apollo GraphQL HTTP 请求 任务队列 任务队列 文件上传 缓存 缓存 验证码 角色鉴权 cfork 代码染色 命令行 Consul 腾讯云对象存储（COS） 本地任务 跨域 CRUD EggJS ETCD 事件 Express gRPC HTTP 代理 多语言 信息查看 JWT Kafka Koa MCP (Model Context Protocol) MikroORM MongoDB MQTT 单次执行 TypeORM 阿里云对象存储（OSS） 身份验证 线程池 pm2 进程 Agent Prometheus RabbitMQ Redis 模板渲染 安全 Sequelize SocketIO 静态文件托管 Swagger TableStore 标签组件 租户 文件上传 参数校验 参数校验 WebSocket 关于 Alias Path 常见框架问题 常见 git 问题 常见 npm 问题 常见 TS 问题 函数式 API 构建部署 前端集成 函数式基础 概览 迁移指南 React 集成 测试 参数校验 Vue 集成 目录与编辑 守卫 接口开发 Hooks 前端请求客户端 使用 Midway 组件 项目配置 跨域 CORS 调试 部署 简易模式 & 文件系统路由 全栈套件 介绍 Web 中间件 Prisma ORM 静态类型安全 + 运行时安全 测试 文件上传 参数校验 如何安装 Node.js 环境 如何更新 Midway 介绍 MongoDB TypeORM Sequelize 任务调度 生命周期 日志（v2） 日志 Web 中间件 使用组件 关于 Midway 启动慢的问题 数据模拟 服务器启动失败排查 管道 流程控制 快速入门 创建第一个应用 Midway 维护计划 Application 和 Context 重试机制 Web 路由表 部署到阿里云函数计算 部署到 AWS Lambda 函数上下文 开发函数 默认错误行为 介绍 Serverless 触发器 POST 情况差异 测试函数 从 Serverless v2 迁移到 v3 服务和注入 服务发现（Service Discovery） 服务工厂 Midway Skill 使用 测试 Midway CLI 脚手架 egg:ts-helper 规则检查工具 Lint 和格式化 开发工具 sequelize-auto-midway typeorm:Model Generator 版本检查工具 链路追踪 2.x 升级指南 3.x 升级指南 路由版本化 ## What is Midway Framework Documentation's llms.txt? Midway Framework Documentation publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Midway Framework Documentation offers and where to find details. Issues Spec 8 Sections 2963 Links 302.3 KB Size ~62.2k Tokens Sections: blog · changelog · index.layout · search · test-webcontainer · tutorials · and 2 more ## Add Midway Framework Documentation Docs to Your AI Assistant Select your tool to see how to add Midway Framework Documentation's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://www.midwayjs.org/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Midway Framework Documentation Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 1093 errors ## Frequently Asked Questions Where is Midway Framework Documentation's llms.txt file? Midway Framework Documentation publishes its llms.txt at https://www.midwayjs.org/llms.txt. This file provides a structured, markdown-formatted index of Midway Framework Documentation's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Midway Framework Documentation's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Midway Framework Documentation's documentation so it can provide better code suggestions and answers about Midway Framework Documentation. What does Midway Framework Documentation's llms.txt contain? Midway Framework Documentation's llms.txt contains 8 sections and 2963 documentation links in 302.3 KB (~62.2k tokens). Key sections include blog, changelog, index.layout, search, test-webcontainer, tutorials. How many tokens does Midway Framework Documentation's llms.txt use? The concise llms.txt index is approximately 62.2k tokens (302.3 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Midway Framework Documentation? Midway is a future-proof, cloud-native Node.js framework for enterprise applications.. Midway Framework Documentation's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Midway Framework Documentation. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [ClickHouse ClickHouse is a fast open-source column-oriented database management system (DBMS) optimized for real-time analytical queries using SQL. It powers large-scale data analytics, supports ClickHouse Cloud as a managed service, and integrates with BI tools, data pipelines, and modern data stacks.](https://mdream.dev/llms-txt/midway/llms-txt/clickhouse) [Agno Build, run, manage agentic software at scale.](https://mdream.dev/llms-txt/midway/llms-txt/agno) [Auth0 blog](https://mdream.dev/llms-txt/midway/llms-txt/auth0) [Modular Deploy fast and scalable GenAI inference](https://mdream.dev/llms-txt/midway/llms-txt/modular) [LearnOpenCV Learn OpenCV : C++ and Python Examples](https://mdream.dev/llms-txt/midway/llms-txt/learnopencv) [Couchbase This is the official documentation for Couchbase, a leading NoSQL distributed database platform](https://mdream.dev/llms-txt/midway/llms-txt/couchbase) [Infisical](https://mdream.dev/llms-txt/midway/llms-txt/infisical) [Vultr Documentation](https://mdream.dev/llms-txt/midway/llms-txt/vultr) [View all 99 projects ](https://mdream.dev/llms-txt/midway/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/midway/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/midway/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)