@dataui/crud-request

中文文档
5.3.4发布于 2024/04/09MITTypeScriptCommonJS近 30 天下载 13.2万

NestJs CRUD for RESTful APIs - request query builder

原始使用文档
文档目录9 节
  1. Features
  2. Install
  3. Packages
  4. Documentation
  5. Support
  6. Contributors
  7. Code Contributors
  8. Financial Contributors
  9. License

CRUD (@dataui/crud-request)

for RESTful APIs built with NestJs


We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find @dataui/crud microframework very useful.

Features

CRUD usage
  • Super easy to install and start using the full-featured controllers and services :point_right:

  • DB and service agnostic extendable CRUD controllers

  • Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.

  • Framework agnostic package with query builder for a frontend usage

  • Query, path params and DTOs validation included

  • Overriding controller methods with ease

  • Tiny config (including globally)

  • Additional helper decorators

  • Swagger documentation

Install

npm i @dataui/crud-request

Packages

  • @dataui/crud - core package which provides @Crud() decorator for endpoints generation, global configuration, validation, helper decorators (docs)
  • @dataui/crud-request - request builder/parser package which provides RequestQueryBuilder class for a frontend usage and RequestQueryParser that is being used internally for handling and validating query/path params on a backend side (docs)
  • @dataui/crud-typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)

Documentation

Support

Any support is welcome. At least you can give us a star.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Organizations

Currently this project is NOT sponsored by anybody. Get in touch if you want to become a sponsor.

License

MIT

版本与发布记录

@dataui/crud-request 共发布 26 个版本,首次发布于 2022/06/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.3.4latest2024/04/092 年前
5.3.32024/03/212 年前
5.3.22024/03/132 年前
5.3.12023/11/103 年前
5.3.1-alpha.32023/07/203 年前
5.3.1-alpha.02023/07/133 年前

其他发布通道:alpha → 5.1.4-alpha.3。

关于 @dataui/crud-request 的常见问题

@dataui/crud-request 是什么?

NestJs CRUD for RESTful APIs - request query builder

如何安装 @dataui/crud-request?

在项目目录运行 npm install @dataui/crud-request,或使用 pnpm add / yarn add / bun add。

@dataui/crud-request 支持 TypeScript 吗?

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

@dataui/crud-request 支持 ESM 还是 CommonJS?

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

@dataui/crud-request 可以商用吗?

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

@dataui/crud-request 的下载量有多少?

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

@dataui/crud-request 还在维护吗?

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