# VextJS Complete English Documentation Index

> Generated from every public English documentation source. Each canonical URL appears exactly once with its source-derived summary.

## English documentation

- [VextJS](https://devcodex-labs.github.io/vextjs/): Ship APIs and server-rendered React pages from one Node.js application with one route model, typed contracts, and built-in docs.
- [Access Log middleware](https://devcodex-labs.github.io/vextjs/api/access-log): VextJS has built-in Access Log middleware, which automatically records the method, path, status code, response time and client IP of each HTTP request. This middleware is based on the onion model (after-middleware mode) and outputs a compact line of access ...
- [Application example](https://devcodex-labs.github.io/vextjs/api/app): This page details the complete API of the VextJS application instance VextApp, including built-in modules, extension methods, life cycle hooks and startup functions.
- [Configuration items](https://devcodex-labs.github.io/vextjs/api/config): This page details all configuration fields, types, default values and usage instructions of VextJS.
- [Request and response](https://devcodex-labs.github.io/vextjs/api/context): This page details the complete API of VextJS's request object VextRequest and response object VextResponse.
- [FetchAPI](https://devcodex-labs.github.io/vextjs/api/fetch): This page provides a simplified API reference for the app.fetch built-in HTTP client. Complete usage guidelines, examples, and best practices are available in the Built-in HTTP Client Guide.
- [Plugin API](https://devcodex-labs.github.io/vextjs/api/plugin-api): This page details the plug-in system API of VextJS, including plug-in definitions, middleware definition helper functions and related types.
- [Route definition](https://devcodex-labs.github.io/vextjs/api/route-definition): This page details the route definition API of VextJS, including defineRoutes, routing options, parameter validation, middleware references and document configuration.
- [Test tools](https://devcodex-labs.github.io/vextjs/api/testing-api): This page details VextJS's testing tool API, including createTestApp, TestApp, TestRequest, TestRequestBuilder and TestResponse.
- [Performance benchmark test](https://devcodex-labs.github.io/vextjs/benchmark): This page shows performance benchmark data comparing VextJS with other popular Node.js web frameworks. The reproducible benchmark of the current version is subject to test/benchmark/run-benchmark.mjs in the warehouse; the historical benchmark warehouse data...
- [CRUD API](https://devcodex-labs.github.io/vextjs/examples/crud-api): A complete RESTful CRUD API example, demonstrating VextJS's core capabilities such as service layer, middleware, parameter verification, and error handling.
- [HelloWorld](https://devcodex-labs.github.io/vextjs/examples/hello-world): The simplest VextJS project to help you understand the basic structure and working of the framework.
- [Nacos access example](https://devcodex-labs.github.io/vextjs/examples/nacos-integration): This example demonstrates how to integrate Nacos in VextJS to implement service registration and discovery, dynamic configuration during runtime, and remote configuration patch during startup.
- [OpenTelemetry Observability](https://devcodex-labs.github.io/vextjs/examples/opentelemetry): This document only introduces how to access @devcodex/opentelemetry in the VextJS scenario.
- [permission-core Auth](https://devcodex-labs.github.io/vextjs/examples/permission-core-auth): This example shows how to connect permission-core to VextJS Auth. Vext keeps authentication and route guards separate:
- [API Client and Contracts](https://devcodex-labs.github.io/vextjs/frontend/api-client-and-contracts): Vext pages do not need a generated API client for first-screen data. Use route handlers and res.render() for that.
- [Boundaries and Roadmap](https://devcodex-labs.github.io/vextjs/frontend/boundaries-and-roadmap): This page separates current frontend targets from future capability tracks.
- [Build and Deploy](https://devcodex-labs.github.io/vextjs/frontend/build-and-deploy): vext build compiles server output and frontend output in one command. This
- [Build, Deploy, and Performance](https://devcodex-labs.github.io/vextjs/frontend/build-deploy-performance): This page is kept as a compatibility entry for older links.
- [Code Splitting](https://devcodex-labs.github.io/vextjs/frontend/code-splitting): Vext splits frontend code around pages, layouts, error pages, locales, and shared runtime chunks.
- [Frontend Configuration](https://devcodex-labs.github.io/vextjs/frontend/configuration): This page is a decision guide, not a second copy of every type member. Start
- [CSR and SPA Fallback](https://devcodex-labs.github.io/vextjs/frontend/csr-and-spa-fallback): The default Vext page model is SSR plus hydration. CSR fallback is scoped and explicit.
- [Data and API Calls](https://devcodex-labs.github.io/vextjs/frontend/data-and-api): This page is kept as a compatibility entry for older links.
- [Data Flow](https://devcodex-labs.github.io/vextjs/frontend/data-flow): Frontend data in Vext starts on the server. Route handlers call services, prepare JSON-safe values, and pass them into res.render().
- [Dev Workflow](https://devcodex-labs.github.io/vextjs/frontend/dev-workflow): vext dev starts the backend runtime and the frontend development pipeline. Frontend output is written to .vext/client/.
- [Diagnostics and Leak Scan](https://devcodex-labs.github.io/vextjs/frontend/diagnostics-and-leak-scan): Leak Scan protects the browser bundle from accidentally importing server-only modules.
- [Error Pages and Document](https://devcodex-labs.github.io/vextjs/frontend/errors-and-document): Default error pages live under:
- [Fast Refresh](https://devcodex-labs.github.io/vextjs/frontend/fast-refresh): Fast Refresh is the default feedback path for React page, layout, and component changes during vext dev.
- [Getting Started](https://devcodex-labs.github.io/vextjs/frontend/getting-started): This page is the shortest path to a working Vext full-stack page with the built-in frontend capability.
- [Hydration](https://devcodex-labs.github.io/vextjs/frontend/hydration): Hydration attaches the browser React tree to the HTML produced by SSR.
- [Hydration Validation](https://devcodex-labs.github.io/vextjs/frontend/hydration-validation): Hydration validation proves that the built page works in a real browser, not only in static build output.
- [Frontend I18n](https://devcodex-labs.github.io/vextjs/frontend/i18n): Backend config.locale remains the full-stack locale foundation. frontend.i18n controls frontend page copy and hydration behavior.
- [Vext JSCSS](https://devcodex-labs.github.io/vextjs/frontend/jscss): Vext JSCSS turns a TypeScript object into a generated CSS class at build time. Use it when a component needs named variants, semantic CSS variables, or nested rules while you still want the final browser to load CSS rather than a CSS-in-JS runtime.
- [Layouts and Components](https://devcodex-labs.github.io/vextjs/frontend/layouts-and-components): Vext layouts are React components named layout.tsx under src/frontend/pages/.
- [Frontend Overview](https://devcodex-labs.github.io/vextjs/frontend/overview): This Frontend guide documents the current built-in Vext frontend capability: route-driven React 19 pages, SSR, hydration, nested layouts, frontend i18n, Fast Refresh, render refresh, code splitting, static assets, CDN upload, performance budgets, and hydrat...
- [Pages and Rendering](https://devcodex-labs.github.io/vextjs/frontend/pages-and-rendering): This page is kept as a compatibility entry for older links.
- [Performance Budgets](https://devcodex-labs.github.io/vextjs/frontend/performance-budgets): Performance budgets keep the React hydration path measurable.
- [Project Structure](https://devcodex-labs.github.io/vextjs/frontend/project-structure): The default vext create scaffold is a full-stack project. Frontend source is grouped under src/frontend/ so server code and browser code stay physically separate.
- [Render Data and Cache](https://devcodex-labs.github.io/vextjs/frontend/render-data-and-cache): Render data is the server-prepared payload used to produce HTML and hydrate the page.
- [Render Refresh](https://devcodex-labs.github.io/vextjs/frontend/render-refresh): Render Refresh handles server-side changes that affect the HTML produced by res.render().
- [Rendering Modes](https://devcodex-labs.github.io/vextjs/frontend/rendering-modes): Vext supports a mixed full-stack frontend model without mixing server files into the browser bundle.
- [Routing and Pages](https://devcodex-labs.github.io/vextjs/frontend/routing-and-pages): Vext keeps URL ownership in src/routes/. Page files are render targets, not automatic URL definitions.
- [SSR](https://devcodex-labs.github.io/vextjs/frontend/ssr): Server-side rendering is the default Vext page path. The route handler owns the URL and prepares the data; the frontend page owns the React view.
- [Static Assets and CDN](https://devcodex-labs.github.io/vextjs/frontend/static-assets-and-cdn): Vext has two static asset locations with different behavior.
- [Styles and Assets](https://devcodex-labs.github.io/vextjs/frontend/styles-and-assets): Global CSS can live under src/frontend/styles/ and be imported by pages, layouts, or generated entries.
- [Troubleshooting](https://devcodex-labs.github.io/vextjs/frontend/troubleshooting): If res.render("dashboard") cannot find a page, check:
- [Adapter architecture](https://devcodex-labs.github.io/vextjs/guide/adapters): One of the core designs of VextJS is the Adapter architecture - the underlying HTTP processing layer is completely replaceable. Your business code (routing, middleware, services, plug-ins) operates on the req / res objects encapsulated by VextJS, rather tha...
- [Build (vext build)](https://devcodex-labs.github.io/vextjs/guide/build): vext build compiles server source code into deployable JavaScript products and, when frontend.enabled is true, bundles the browser client into dist/client/. The current version of vext build is designed as a production-target build: it statically injects pr...
- [Response caching](https://devcodex-labs.github.io/vextjs/guide/cache): VextJS provides declarative route-level response caching, configured through the cache field of the route options. When the cache is hit, parameter verification and handler execution are skipped, and the cached JSON response is returned directly.
- [CLI commands](https://devcodex-labs.github.io/vextjs/guide/cli): VextJS provides the vext command line tool, covering the complete life cycle of project creation, development, construction and deployment.
- [Cluster multi-process](https://devcodex-labs.github.io/vextjs/guide/cluster): VextJS has built-in Cluster multi-process management, manages multiple Worker processes through ClusterMaster, makes full use of multi-core CPUs, and supports enterprise-level features such as zero-downtime rolling restart, heartbeat detection, and automati...
- [Configuration](https://devcodex-labs.github.io/vextjs/guide/configuration): VextJS uses a multi-layer configuration merging mechanism to support configuration overrides by environment, while providing a rich set of built-in configuration items to cover framework behaviors.
- [Cookies and Sessions](https://devcodex-labs.github.io/vextjs/guide/cookies-session): Vext provides first-party cookie parsing, response cookie helpers, and a configuration-driven Session runtime. The feature is zero-dependency and works across Native, Hono, Fastify, Express, and Koa adapters.
- [en/guide/database](https://devcodex-labs.github.io/vextjs/guide/database): VextJS has a built-in MonSQLize database plug-in, providing out-of-the-box MongoDB database support. Just add the database field in the configuration file, and the framework will automatically complete connection management, model loading and resource cleanup.
- [Deployment and production environment](https://devcodex-labs.github.io/vextjs/guide/deployment): This guide explains how to deploy a VextJS application into production, covering practices such as building, Docker containerization, Nginx reverse proxy, PM2 process management, log collection, and health checks.
- [Error handling](https://devcodex-labs.github.io/vextjs/guide/error-handling): VextJS will uniformly capture exceptions thrown in routes, middleware, and services and convert them into HTTP responses. app.throw(...) is preferred when actively returning business errors; VextValidationError is used when field-level verification fails; t...
- [Built-in HTTP client (app.fetch)](https://devcodex-labs.github.io/vextjs/guide/fetch): VextJS has a built-in enhanced HTTP client app.fetch, which is based on the Node.js 20+ native fetch package and provides capabilities such as requestId automatic propagation, timeout control, automatic retry, structured log, create() factory and config dri...
- [Frontend integration](https://devcodex-labs.github.io/vextjs/guide/frontend): This page is kept for existing links.
- [Runtime Hooks](https://devcodex-labs.github.io/vextjs/guide/hooks): app.hooks.on(name, handler) is used to observe or lightweight patch framework runtime life cycle. It is suitable for cross-cutting logic such as request auditing, request records after verification, response header patch, outbound call monitoring, service c...
- [Hot reload](https://devcodex-labs.github.io/vextjs/guide/hot-reload): VextJS has a built-in intelligent hot reload mechanism and starts development mode through the vext dev command. The framework will monitor file changes and automatically select the optimal reload strategy based on the type of change, from millisecond-level...
- [Internationalization (i18n)](https://devcodex-labs.github.io/vextjs/guide/i18n): VextJS has built-in internationalization support and realizes multi-language translation of error messages through language pack files in the src/locales/ directory. Language packs are automatically scanned and loaded by i18n-loader, and are seamlessly link...
- [Introduction](https://devcodex-labs.github.io/vextjs/guide/introduction): VextJS is a full-stack Node.js framework for applications that need APIs, server-rendered React pages, or both. src/routes/ remains the URL authority while services, validation, security, cache, OpenAPI, and typed clients share the same request contracts. Y...
- [Logger](https://devcodex-labs.github.io/vextjs/guide/logger): VextJS has a built-in Vext logger kernel with zero runtime dependency, which can be used anywhere in the framework through app.logger. By default, it provides capabilities such as structured JSON, pretty/JSON dual mode, pretty level color output, requestId ...
- [middleware](https://devcodex-labs.github.io/vextjs/guide/middleware): VextJS's middleware uses the Onion Model to support pre-request processing and post-response processing. The framework provides two definition methods: defineMiddleware and defineMiddlewareFactory, which are automatically scanned and loaded through the agre...
- [OpenAPI Documentation](https://devcodex-labs.github.io/vextjs/guide/openapi): VextJS has built-in automatic generation of OpenAPI documentation. Based on route validate and docs configuration, the framework generates an OpenAPI 3.0 JSON document and serves the default /docs page with the Vext Docs Renderer. Third-party documentation ...
- [plugin](https://devcodex-labs.github.io/vextjs/guide/plugins): The plug-in system of VextJS is the only extension entrance to the framework. Through plug-ins, you can inject custom capabilities into the app object, register global middleware, replace built-in implementations, and manage resource life cycles.
- [Preload](https://devcodex-labs.github.io/vextjs/guide/preload): VextJS provides the Preload mechanism, allowing the following two types of sources to execute scripts before the Node.js module is loaded:
- [Project structure](https://devcodex-labs.github.io/vextjs/guide/project-structure): VextJS follows the design philosophy of convention over configuration and implements automatic scanning, loading and registration through a fixed directory structure, without the need to manually configure route mapping or service injection.
- [Quick start](https://devcodex-labs.github.io/vextjs/guide/quick-start): VextJS provides the vext create command to create a runnable project. The default template proves the one-route model immediately: / renders React through res.render(), /api/hello returns JSON, and both use the generated example service. Choose API-only whe...
- [Request Context (Request Context)](https://devcodex-labs.github.io/vextjs/guide/request-context): VextJS implements request-level context storage requestContext based on Node.js AsyncLocalStorage, maintaining independent context data for each request. There is no need to manually pass parameters, and the context information of the current request can be...
- [routing](https://devcodex-labs.github.io/vextjs/guide/routing): VextJS uses conventional file routing + three-stage routing definition to automatically map file paths to URL prefixes, and declare specific routes inside the file through defineRoutes().
- [Service layer](https://devcodex-labs.github.io/vextjs/guide/services): VextJS adopts a layered architecture and concentrates business logic on the service layer (Service Layer). Service files are placed in the src/services/ directory, automatically scanned, instantiated and injected into app.services by the framework, and acce...
- [test](https://devcodex-labs.github.io/vextjs/guide/testing): VextJS has a complete built-in testing tool, imported through the vextjs/testing subpath. Routers, middleware, and services can be tested end-to-end without starting a real HTTP server.
- [Parameter verification](https://devcodex-labs.github.io/vextjs/guide/validation): VextJS integrates schema-dsl to provide declarative parameter verification. Use concise DSL strings to describe verification rules in the route options.validate. The framework automatically completes verification, type conversion, and generates OpenAPI docu...
- [Documentation Data and AI](https://devcodex-labs.github.io/vextjs/resources/documentation-data-and-ai): Canonical, machine-readable documentation assets and a privacy-first measurement boundary for VextJS.
- [Support and Services](https://devcodex-labs.github.io/vextjs/resources/support-and-services): A scoped, maintainer-led path for production reviews, migration work, and team enablement.