NewLife.Cube.Swagger 6.16.2026.1030

NewLife.Cube - Web rapid development and admin framework

🌐 简体中文 | 繁體中文 | Español | Deutsch | 日本語 | Français | Português | Русский | 한국어 | العربية

NewLife.Cube is a rapid web development platform for "data-driven + fast iteration + deep customization" scenarios. In minutes, an entity class or database table becomes a complete admin UI with permissions, lists, details, CRUD, export and statistics, while standard APIs are exposed for Vue (official front-end) / React / Antd / mobile or third-party systems. The default template has been proven in real projects with a single table of 10 billion rows.

Demo: https://cube.newlifex.com CentOS7 + CDN · SSO center: https://sso.newlifex.com OAuth server · Swagger: https://cube3.newlifex.com

Cube tutorial: https://newlifex.com/cube · XCode tutorial: https://newlifex.com/xcode · Core library tutorial: https://newlifex.com/core

Contents: Quick Start · Main Features · Ecosystem Map · Documentation · Contributing · Team · License

Quick Start

Install

Install NewLife.Cube.Core from NuGet. MIT licensed; you may replace the "NewLife" string for private builds. Works with Visual Studio and the CLI. newlife.snk is public for strong-name consistency.

dotnet add package NewLife.Cube

Template scaffolding

dotnet new install NewLife.Templates
dotnet new cube --name CubeWeb
dotnet new xcode --name Zero.Data
cd CubeWeb
dotnet build
start http://localhost:6080
dotnet run

Minimal example (.NET 8/9 Minimal Hosting)

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddCube(); // registers permissions, menus, entity controller scanning
var app = builder.Build();
app.UseMetronic(app.Environment); // or UseAdminLTE / UseTabler ...
app.UseCube(app.Environment);      // routing, static assets and middleware
app.Run();

Open / to sign in, use Swagger for APIs, and call the standard CRUD APIs from any front-end.

Platform support

ASP.NET Core installation

• Create an ASP.NET Core Web project in Visual Studio.
• Reference NewLife.Cube.Core from NuGet, or build the latest Cube NewLife.CubeNC source.
• Set a connection string named Membership in appsettings.json; users, roles, permissions and menus are stored there.
• The database type is detected automatically; the default is Data Source=../Data/Membership.db.
• Build the project, right-click → View → View in Browser to run Cube.
• MySQL/SQLite/Oracle/SqlCe drivers are downloaded automatically (x86/x64); change PluginServer in Config/Core.config if needed.
• Scripts and styles are downloaded automatically; change PluginServer in Config/Cube.config if needed.
• The default login is admin/admin; third-party OAuth such as NewLife also works. The first user becomes administrator and admin is disabled.
• When publishing, copy *.dll, appsettings.json, *.deps.json, *.runtimeconfig.json and your own assets.

ASP.NET MVC installation

• Create an ASP.NET MVC project in Visual Studio.
• Reference NewLife.Cube from NuGet, or build the latest Cube NewLife.Cube source.
• Set a connection string named Membership in the <connectionStrings> section of Web.config.
• The database type is detected automatically; the default is <add name="Membership" connectionString="Data Source=../Data/Membership.db" providerName="Sqlite"/>.
• Build the project, right-click → View → View in Browser to run Cube.
• MySQL/SQLite/Oracle/SqlCe drivers are downloaded automatically (x86/x64); change PluginServer in Config/Core.config if needed.
• Scripts and styles are downloaded automatically; change PluginServer in Config/Cube.config if needed.
• The default login is admin/admin; third-party OAuth such as NewLife also works. The first user becomes administrator and admin is disabled.
• Installing the Razor Generator Visual Studio extension and setting it as the custom tool for .cshtml files compiles views into the DLL.
• Publish and copy the DLLs, configuration and assets.

Main Features

<details> <summary><b>Data-to-UI productivity</b> (9)</summary>

</details>

<details> <summary><b>Field and UI customization</b> (3)</summary>

public class AppController : EntityController<App, AppModel>
{
    static AppController()
    {
        LogOnChange = true;                 // change log
        ListFields.RemoveField("Secret");   // hide a sensitive column
        var log = ListFields.AddListField("Log", "UpdateUserId");
        log.DisplayName = "Change log";
        log.Url = "/Admin/Log?category=App&linkId={ID}";
        log.Target = "_blank";
    }
}

</details>

<details> <summary><b>API and front-end separation</b> (6)</summary>

</details>

<details> <summary><b>Permissions and security</b> (7)</summary>

</details>

<details> <summary><b>AI capabilities</b> (4)</summary>

</details>

<details> <summary><b>Front-ends, themes and skins</b> (7)</summary>

The skins above are reference implementations kept in this repository and are not published to NuGet. NewLife.Cube.Vue (official, full unit and E2E coverage) and NewLife.Cube.React (separate repository) are published as NuGet packages with the front-end embedded; after AddCube + UseCube, Cube auto-detects every referenced skin package and you can switch the active skin via the SpaSkin setting without any extra call.

// Pick one
app.UseNaiveUI(app.Environment);
app.UseMUI(app.Environment);
app.UseShadcn(app.Environment);
app.UseArcoVue(app.Environment);
app.UseAngular(app.Environment);
app.UseVuetify(app.Environment);
app.UseSvelte(app.Environment);
app.UseTDesign(app.Environment);

Front-end workspace conventions:

• Root pnpm build: builds only the shared modules under packages/; it no longer recurses into every skin.
• Build one skin: pnpm build:vue, pnpm build:naive, pnpm build:mui, pnpm build:shadcn, pnpm build:arco, pnpm build:angular, pnpm build:vuetify, pnpm build:svelte, pnpm build:tdesign.
• Develop one skin: the matching pnpm dev:xxx.
• Build or start everything: pnpm build:all / pnpm dev:all.
• Inside a skin's web/ directory, use its own pnpm build / pnpm dev.

</details>

<details> <summary><b>Data and big data</b> (5)</summary>

</details>

<details> <summary><b>Performance and NativeAOT</b> (4)</summary>

</details>

<details> <summary><b>Deployment and operations</b> (5)</summary>

Deploying the user center

1. Clone the source, build CubeSSO, go to Bin/SSO, adjust appsettings.json, package the exe/dll/appsettings/runtimeconfig files and deploy.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "Urls": "http://*:8080;https://*:8081",
  //"StarServer": "http://star.newlifex.com:6600",
  "ConnectionStrings": {
    "Membership": "Data Source=../Data/Membership.db;provider=sqlite",
    "Cube": "Data Source=../Data/Cube.db;provider=sqlite",
    "Log": "Data Source=../Data/Log.db;provider=sqlite"
  }
}

2. Start and open the SSO site. The first login can use admin/admin or a third-party login; the first user becomes administrator and admin is disabled.
3. For a production user center, disable third-party login: Cube settings → OAuth → disable all.
4. Rename the system in Cube settings → System → Display name.

</details>

<details> <summary><b>Cube generation 3</b> (5)</summary>

Front-end repositories:
https://github.com/NewLifeX/NewLife.CubeVue · https://github.com/NewLifeX/NewLife.QuickVue · https://github.com/NewLifeX/NewLife.CubeAntd · https://github.com/NewLifeX/NewLife.CubeBlazor

Live sites: Vue https://vue.newlifex.com, https://quickvue.newlifex.com · Antd https://antd.newlifex.com · Swagger https://cube3.newlifex.com/swagger/index.html

Participation notes:

1. Join the NewLifeX team and submit to the dev branch.
2. WebApi backend: NewLife.Cube; MVC stays in NewLife.CubeNC.
3. New front-ends live in independent repositories (e.g. NewLife.CubeAntd).
4. Mark owners in docs and code.
5. Tasks: https://github.com/orgs/NewLifeX/projects/1.

Milestones (excerpt):

• New WebApi project NewLife.Cube
• Move NetCore-specific code to NewLife.CubeNC
• New EntityController / EntityReadOnlyController
• API docs and Vue login page
• Vue user/role list and forms

</details>

<details> <summary><b>Architecture and projects</b> (9)</summary>

+-------------------------------------------------------------+
|         Front-end (Vue / Blazor / Antd / classic Razor)      |
+----------------------+------------------+-------------------+
|  Skin views (Razor)  |  API Controllers | Swagger by area   |
+----------------------+------------------+-------------------+
|  EntityController / ReadOnlyEntityController core            |
+------------------+---------------------+--------------------+
| Permissions (EntityAuthorize) | Filters (ApiFilter) | ApiResponse |
+-------------------------------------------------------------+
|            Entities & business logic (XCode ORM + extensions)|
+-------------------------------------------------------------+
| Data access: MySql/SqlServer/SQLite/Oracle/PostgreSQL/DM ... |
+-------------------------------------------------------------+
| NewLife.Core (logging/config/cache/serialization/tracing)     |
+-------------------------------------------------------------+

</details>

<details> <summary><b>Core concepts</b> (7)</summary>

</details>

<details> <summary><b>Common scenarios</b> (5)</summary>

</details>

Ecosystem Map

NewLife is a layered ecosystem of independently versioned open-source projects. The map below is shared verbatim by every NewLife repository; each project links to its repository and its primary NuGet package.

Project	What it does	Downloads
Foundation
NewLife.Core	Logging, configuration, caching, networking, serialization, scheduling and APM tracing.
NewLife.XCode	Data middleware: single tables at the tens-of-billions scale, automatic sharding, read-write splitting, 10+ databases.
NewLife.Net	High-performance network library: 1.77M pps / 14.5 Gbps on a single machine (TCP 1KB, 2026-10), 4M long-lived TCP connections.
NewLife.Remoting	Protocol communication and RPC framework for client/server applications and IoT devices.
NewLife.Agent	Installs .NET applications as OS daemons: Windows services and Linux systemd.
NewLife.Templates	dotnet new project templates for console, web, API, service, data and IoT projects.
Data & Messaging
NewLife.Redis	Redis client with microsecond latency, millions of ops/s and built-in message queues.
NewLife.RocketMQ	Pure managed RocketMQ client for Apache RocketMQ and Alibaba Cloud Message Queue.
NewLife.MQTT	MQTT client and server, including Alibaba Cloud IoT connectivity.
NewLife.NovaDb	Hybrid database in C#: embedded or networked, relational, time-series, message queue and KV in one.
NewLife.MySql	MySql driver and helper layer built on the NewLife data stack.
Web, AI & Distributed
NewLife.Cube	Rapid admin-platform framework: permissions, SSO, OAuth server and CRUD scaffolding.
Stardust	Distributed service platform: node management, APM, configuration center, registry and release center.
AntJob	Distributed task and real-time data scheduling platform with sharding, retries and backfill.
NewLife.AI	Unified client for 46 LLM providers plus ChatAI, a ready-to-run web chat application.
Industrial & IoT
NewLife.IoT	IoT standard library defining protocol contracts and device abstractions.
NewLife.Modbus	Modbus TCP/RTU/ASCII implementation on top of NewLife.IoT.
NewLife.Siemens	Siemens PLC protocol on top of NewLife.IoT.
NewLife.Omron	Omron PLC protocol on top of NewLife.IoT.
NewLife.Melsec	Mitsubishi Melsec PLC protocol on top of NewLife.IoT.
NewLife.OPC	OPC client for industrial data access.	—
NewLife.BACnet	BACnet building-automation protocol stack.
ZeroIoT	Lightweight open-source IoT platform with gateway and device management.	—
Vehicle Telematics
NewLife.JT808	JT/T 808 vehicle positioning protocol: 70+ message bodies, 2011/2013/2019.
NewLife.JT809	JT/T 809 platform-to-platform protocol for transport authorities.
NewLife.JT1078	JT/T 1078 in-vehicle video: RTP parsing, FLV/fMP4 remuxing and live streaming.
Domain Components
NewLife.Office	One package for Excel, Word, PPT, PDF and 15+ document formats.
NewLife.Audio	Cross-platform audio: codecs, device I/O, DSP, containers and streaming.
NewLife.Video	Video codecs, container formats, frame processing and streaming.
NewLife.Map	Unified interface over Baidu, AMap, Tencent and Tianditu with geocoding and coordinate conversion.
NewLife.IP	IPv4 geolocation with an offline memory-mapped database and an online API fallback.
Tools & Products
CrazyCoder	Developer toolbox: network, serial port, crypto, regex, Modbus and MQTT.
GitCandy	Self-hosted Git source code management system.	—
LuckyClover	Installs the matching .NET runtime automatically when launched from an older host.	—

Badges show the primary package of each project; theme, extension and satellite packages are listed on their NuGet pages.The 30+ packages not listed here (FTP, LoRa, Office extensions, protocol drivers and more) are available under the NewLifeX organization and on newlifex.com. This table is maintained in the NewLife.Core README.

Documentation

Guides

Detailed requirements, feature tracking and architecture live in Doc/ (written in Chinese):

• 📋 Requirements — vision, goals, functional requirements
• ✅ Feature list — implementation/test/comment tracking
• 🏗️ Architecture — layering, modules, key decisions
• 🧩 Page presentation — dynamic / hybrid / custom pages, backend and frontend extension ladders
• 🤖 AI — AI capabilities, configuration and extension points
• 🔔 Alerts and inbox — online threshold alerts and broadcast messages
• ✉️ Email/phone verification — activation contract and UI integration
• 🛡️ Security — threat detection, auto-ban and security audit
• 📚 User manual — full user and developer guide

Tutorials

• Cube tutorial: https://newlifex.com/cube
• XCode tutorial: https://newlifex.com/xcode
• Core library tutorial: https://newlifex.com/core
• Online demo: https://cube.newlifex.com · SSO center: https://sso.newlifex.com · Swagger: https://cube3.newlifex.com

FAQ

Q: Hide a field?
A: In the controller static constructor: ListFields.RemoveField("Field").

Q: Custom statistics?
A: Override search logic and fill stat on the returned collection.

Q: Switch themes?
A: Reference a theme package and call app.UseXXX(env); the default is configurable in the admin UI.

Q: Where do database drivers come from?
A: Downloaded from PluginServer on first run; configurable.

Q: Integrate a custom front-end?
A: Use the field metadata API plus the standard CRUD/JWT endpoints.

Contributing

Build and test

Cube builds with the .NET SDK 10 (or the matching SDK for your target framework) and also opens in Visual Studio. The front-end skins use pnpm.

dotnet build NewLife.Cube/NewLife.Cube.csproj -c Release
dotnet test XUnitTest -c Release

• End-to-end MVC tests: E2EMvcTest/
• NativeAOT smoke: AotSmoke/, CI in .github/workflows/aot.yml
• Web smoke: WebSmoke/ starts Kestrel and performs one HTTP round-trip

Release

Push a v-prefixed tag to trigger .github/workflows/publish.yml; the workflow packs NewLife.Cube / NewLife.Cube.Core and publishes them to NuGet.org. Package README is generated from README.md by sync-readme-package.ps1, language switchers by sync-readme-languages.ps1 and metric badges by sync-readme-metrics.ps1; each script supports -Check for CI.

Feedback

• Conventions: see .github/copilot-instructions.md.
• Issues/PRs: describe the scenario, expectation and reproduction; include data scale for performance topics.
• New themes: separate repository + README describing the build.
• Prefer the NewLife ecosystem and avoid unnecessary dependencies.
• Make sure all TFMs compile before submitting.

Team

<img src="https://newlifex.com/logo.png" width="48" align="right" alt="NewLife" />

Founded in 2002, the NewLife team has spent more than two decades on the .NET and IoT ecosystem, maintains nearly 100 open-source projects (34 of them core to this map), and delivers integrated software and hardware solutions for power, logistics, healthcare, industrial control and internet industries. We live by the motto "learning has no seniority — mastery earns respect".

Open-source components have been downloaded 6.48M times from NuGet (ecosystem-wide, as of 2026-10).

Website: https://newlifex.com · Open source organization: https://github.com/NewLifeX

<details> <summary>WeChat Official Account: 智能大石头 (scan to follow)</summary>

</details>

License

This project is licensed under MIT; the strong-name certificate newlife.snk is published so you can build and replace assemblies yourself, and the source may be modified and redistributed without attribution.

If this project is helpful to you, welcome to Star it, share it with your team, or provide improvement suggestions via Issue/PR.