# @dataui/crud 中文文档

规范地址：https://npmcn.com/package/%40dataui/crud/

版本：5\.3\.4
npm 元数据更新时间：2024-04-09T02:46:31.807Z
中文译文更新时间：2026-11-11T15:15:21.413Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dataui/crud
原文对照：https://npmcn.com/package/%40dataui/crud/?lang=original
项目主页：https://github.com/gid-oss/dataui-nestjs-crud#readme
源码仓库：https://github.com/gid-oss/dataui-nestjs-crud

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：168 kB，141 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：class-transformer \*，class-validator \*
- 首次发布：2022-06-15T10:45:07.188Z
- 最新版本发布：2024-04-09T02:46:31.595Z
- 近 30 天下载量：123462（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 0 个）

## 中文简介

Restful API 的 NestJs CRUD 存储器

## 安装

```sh
npm install @dataui/crud
```

也可以使用：`pnpm add @dataui/crud`、`yarn add @dataui/crud`、`bun add @dataui/crud`

## README

# CRUD (@ dataui/ crad) (中文(简体) )

**用于使用 NestJs 构建的 RESTFL API**

  

 [![Build](https://github.com/gid-oss/dataui-nestjs-crud/workflows/Tests/badge.svg)](https://travis-ci.org/gid-oss/dataui-nestjs-crud)[![Coverage](https://coveralls.io/repos/github/gid-oss/dataui-nestjs-crud/badge.svg) ](https://coveralls.io/github/gid-oss/dataui-nestjs-crud?branch=master)[![License](https://img.shields.io/github/license/gid-oss/dataui-nestjs-crud.svg) ](https://github.com/gid-oss/dataui-nestjs-crud/blob/master/LICENSE)[![npm version](https://img.shields.io/npm/v/@dataui/crud.svg) ](https://www.npmjs.com/package/@dataui/crud)[![npm downloads](https://img.shields.io/npm/dm/@dataui/crud.svg) ](https://www.npmjs.com/org/nestjsx)[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg) ](https://renovatebot.com/)[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square) ](http://makeapullrequest.com/)[![Awesome REST](https://raw.githubusercontent.com/gid-oss/dataui-nestjs-crud/master/img/awesome-rest.svg?sanitize=true) ](https://github.com/marmelab/awesome-rest#nodejs)[![Awesome Nest](https://raw.githubusercontent.com/gid-oss/dataui-nestjs-crud/master/img/awesome-nest.svg?sanitize=true) ](https://github.com/juliandavidmr/awesome-nestjs#components--libraries)[![Nest Powered](https://raw.githubusercontent.com/gid-oss/dataui-nestjs-crud/master/img/nest-powered.svg?sanitize=true)](https://github.com/nestjs/nest)

由 [@迈克尔·雅利](https://twitter.com/MichaelYali) 财务报告和审定财务报表 [贡献者](https://github.com/gid-oss/dataui-nestjs-crud/graphs/contributors)

  

我们相信,所有与雀巢Js合作并建设一些RESTful服务,特别是一些CRUD功能的人,都会发现 `@dataui/crud` 微框架非常有用.

## 特征

![CRUD usage](https://raw.githubusercontent.com/gid-oss/dataui-nestjs-crud/master/img/crud-usage2.png)

-   超易安装并开始使用全功能控制器和服务 :point right:
    
-   DB 和服务不可知可扩展 CRUD 控制器
    
-   以过滤,平分,排序,关系,巢接关系,缓存等方式到达查询解析.
    
-   前端使用带有查询构建器的框架不可知软件包
    
-   包括查询、路径参数和 DTOs 验证
    
-   轻松地覆盖控制器方法
    
-   小型配置(包括全球)
    
-   额外的辅助装饰器
    
-   Swagger 文档
    

## 安装

```shell
npm i @dataui/crud class-transformer class-validator
```

## 软件包

-   [**@ dataui/ crud (英语)**](https://www.npmjs.com/package/@dataui/crud) - 核心软件包,提供 `@Crud()` 端点生成、全局配置、验证、辅助装饰的装饰者([文档](https://gid-oss.github.io/dataui-nestjs-crud/controllers/#description)(中文(简体) )
-   [**@ dataui/ crud 请求**](https://www.npmjs.com/package/@dataui/crud-request) - 请求提供构建器/参数包 `RequestQueryBuilder` 前端使用类和 `RequestQueryParser` 用于后端处理和验证查询/路径参数([文档](https://gid-oss.github.io/dataui-nestjs-crud/requests/#frontend-usage)(中文(简体) )
-   [**@ dataui/ crud 类型校正**](https://www.npmjs.com/package/@dataui/crud-typeorm) - 提供基础的TypeORM包 `TypeOrmCrudService` 使用 CRUD 数据库操作方法([文档](https://gid-oss.github.io/dataui-nestjs-crud/service-typeorm/)(中文(简体) )

## 文档

-   [一般情况](https://gid-oss.github.io/dataui-nestjs-crud/)
-   [CRUD 控制器](https://gid-oss.github.io/dataui-nestjs-crud/controllers/#description)
-   [CRUD ORM 服务](https://gid-oss.github.io/dataui-nestjs-crud/services/)
-   [处理请求](https://gid-oss.github.io/dataui-nestjs-crud/requests/#description)

## 支助

欢迎任何支持。 至少你可以给我们一颗星.

## 贡献者

### 代码贡献者

这个项目的存在要归功于所有作出贡献的人[贡献](https://npmcn.com/package/%40dataui/crud/CONTRIBUTING.md)\[ \[ \] \[ \] \]. \]. [![](https://opencollective.com/nestjsx/contributors.svg?width=890&button=false)](https://github.com/dataui/crud/graphs/contributors)

### 财政捐助者

#### 组织

目前这个项目没有任何人赞助。 如果你想成为赞助商就联系.

## 许可证

[麻省理工学院](https://npmcn.com/package/%40dataui/crud/LICENSE)

## 常见问题

### @dataui/crud 是什么？

Restful API 的 NestJs CRUD 存储器

### 如何安装 @dataui/crud？

在项目目录运行 npm install @dataui/crud，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：class-transformer（\*）、class-validator（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dataui/crud 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dataui/crud 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dataui/crud 可以商用吗？

@dataui/crud 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dataui/crud 的下载量有多少？

根据 npm 官方下载统计，@dataui/crud 在 2026/10/12 – 2026/11/10 这 30 天内被下载 123,462 次，日均约 4,115 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dataui/crud 还在维护吗？

最新版本 5\.3\.4 发布于 2024/04/09（2 年前）；至今共发布 26 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/06/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。