express-sequelize-autocrud
Version:
Express Sequelize AutoCRUD: Simplify API development with automatic CRUD routes for Sequelize models in Express.js.
132 lines (102 loc) • 9.31 kB
Markdown
Express Sequelize AutoCRUD is a powerful and developer-friendly TypeScript library designed to simplify the creation of CRUD (Create, Read, Update, Delete) routes for your Sequelize models in an Express.js application. If you're building RESTful APIs with Express and using Sequelize as your ORM, this library will save you significant development time and effort.
[](https://www.npmjs.com/package/express-sequelize-autocrud)
[](./LICENSE)
[](https://github.com/doralteres/express-sequelize-autocrud/issues)
[](https://github.com/doralteres/express-sequelize-crud/actions/workflows/release.yaml)
[](https://github.com/google/gts)
[](http://commitizen.github.io/cz-cli/)
## Features
- **Automatic CRUD Operations:** Easily generate CRUD endpoints for your Sequelize models with just a few lines of code.
- **Customizable Routes:** Configure routes according to your project's specific requirements.
- **Validation and Error Handling:** Built-in request validation and error handling for seamless API development.
- **Middleware Support:** Integrate custom middleware functions with generated routes to extend functionality.
- **Transaction Support:** Create, Update and Delete routes runs inside [sequelize transaction](https://sequelize.org/docs/v6/other-topics/transactions/) to handle pre/post hooks and rollback automatically in case something failed in the process.
- **Secure and Efficient:** Utilizes Sequelize's robust security features and optimized database queries.
## Installation
Using npm:
```bash
npm i express-sequelize-autocrud
```
Using yarn:
```bash
yarn add express-sequelize-autocrud
```
Using pnpm:
```bash
pnpm i express-sequelize-autocrud
```
## Usage
Using Express Sequelize AutoCRUD is straightforward:
```typescript
import express from 'express';
import {Sequelize} from 'sequelize';
import sequelizeCrud from 'express-sequelize-autocrud';
const app = express();
const sequelize = new Sequelize('your_db', 'your_user', 'your_password', {
host: 'localhost',
dialect: 'mysql',
});
// Define your Sequelize models here
// Generate routes using express-sequelize-autocrud
app.use(
'/api',
sequelizeCrud(sequelize, {
'/users': {
model: sequelize.model('users'),
operations: {
getList: {
filterableFields: ['id', 'gender'],
attributes: ['id', 'fullName', 'gender'],
limit: 100,
},
getOne: {
attributes: req =>
req.user.role === 'admin'
? ['id', 'fullName', 'secretStuf']
: ['id', 'fullName'],
},
create: {
creatableFields: {exclude: ['id']},
},
update: {
updatableFields: {exclude: ['id']},
},
delete: {
middleware: (req, res, next) => {
if (req.user.role === 'admin') {
next();
} else {
res.sendStatus(403);
}
},
},
},
},
})
);
// Start your Express server
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
```
> Check out our [example project](./example) for more features and complex use-cases
| Operation | URL | Sequelize Operation | Comment |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **getList** | Clean:<br>_GET_ `<API_URL>/<BASE_PATH>`<br><br>With pagination:<br>_GET_ `<API_URL>/<BASE_PATH>?_start=30&_end=60`<br><br>With sort & filters:<br>_GET_ `<API_URL>/<BASE_PATH>?_sort=createdAt&_order=DESC&gender=female` | `findAll()`<br>or<br>`findAndCountAll()` | - Enable pagination with `pagination: true` in the config.<br>- Pagination automatically adds `Content-Range` header.<br>- Can control which fields can be filterable using `filterableFields` in the config.<br>- Can control which fields can be sortable using `sortableFieldsFields` in the config. |
| **getOne** | _GET_ `<API_URL>/<BASE_PATH>/:resourceId` | `findByPk()`<br>or<br>`findOne()` | - Can set custom key (not primary key) using `byField` in the config. |
| **create** | _POST_ `<API_URL>/<BASE_PATH>` | `create()` | - Can control which fields can be added to body request using `creatableFields` in the config. |
| **bulkCreate** | _POST_ `<API_URL>/<BASE_PATH>/bulk` | `bulkCreate()` | - Can control which fields can be added to body request using `creatableFields` in the config.<br />- Can custom the url path with `path` in the config (default: `/bulk`) |
| **update** | _PUT_ `<API_URL>/<BASE_PATH>/:resourceId` | `update()` | - Can control which fields can be added to body request using `updatableFields` in the config.<br/>- Can set custom key (not primary key) using byField in the config. |
| **delete** | _DELETE_ `<API_URL>/<BASE_PATH>/:resourceId` | `destroy()` |- Can set custom key (not primary key) using byField in the config. |
## Documentation
For detailed usage instructions, examples, and customization options, please refer to our [TypeDoc site](https://doralteres.github.io/express-sequelize-autocrud/) or [Documentation.md](./DOCUMENTATION.md).
## Contributing
We welcome contributions from the open-source community! Feel free to open issues, submit pull requests, or provide feedback to help us improve this library.
## License
This project is licensed under the [MIT](./LICENSE) License.
---
With Express Sequelize AutoCRUD, streamline your API development process, reduce boilerplate code, and focus on building robust applications. Happy coding!
If you have any questions, encounter issues, or want to collaborate, please don't hesitate to get in touch with us. We appreciate your support!