Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mvillarrealb/sequelize-resource-controller

CRUD REST Api from your sequelize model for restify and express
https://github.com/mvillarrealb/sequelize-resource-controller

crud-api expressjs resource-api rest-api restify sequelize

Last synced: about 1 month ago
JSON representation

CRUD REST Api from your sequelize model for restify and express

Host: GitHub
URL: https://github.com/mvillarrealb/sequelize-resource-controller
Owner: mvillarrealb
License: mit
Created: 2018-10-31T22:22:44.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2018-11-05T02:40:10.000Z (about 6 years ago)
Last Synced: 2024-09-29T12:40:55.523Z (about 2 months ago)
Topics: crud-api, expressjs, resource-api, rest-api, restify, sequelize
Language: JavaScript
Size: 389 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# sequelize-resource-controller

[![npm version](https://img.shields.io/npm/v/sequelize-resource-controller.svg)](https://www.npmjs.com/package/sequelize-resource-controller)
[![Build Status](https://travis-ci.org/mvillarrealb/sequelize-resource-controller.svg?branch=master)](https://travis-ci.org/mvillarrealb/sequelize-resource-controller)
[![codecov](https://codecov.io/gh/mvillarrealb/sequelize-resource-controller/branch/master/graph/badge.svg)](https://codecov.io/gh/mvillarrealb/sequelize-resource-controller)
![node](https://img.shields.io/node/v/sequelize-resource-controller.svg)
[![License](https://img.shields.io/npm/l/sequelize-resource-controller.svg?maxAge=2592000?style=plastic)](https://github.com/mvillarrealb/sequelize-resource-controller/blob/master/LICENSE)

sequelize-resource-controller is a REST Resource abstraction layer, wich handles all the burden of creating transactions, handling rollbacks and formatting responses for your Resource based Api with sequelize.

Provides support for Restify and Express, two of the most popular http frameworks for nodejs.

# Installation

```bash
npm install --save sequelize-resource-controller
```

# Documentation

You can check [ESDOC documentation](https://mvillarrealb.github.io/sequelize-resource-controller/)

# Examples

## Basic Example (Todo List Api)

The basic example is just a straighforward todo Api with very few files(one file for the database & models, and one for each implementation).

Endpoint|verb|Description
--|---|---
/todos|POST| Creates a new TODO
/todos|GET| Gets all TODOS
/todos/:todo_id|GET| Get a single TODO by id
/todos/:todo_id|PUT| Updates a Todo
/todos/:todo_id|DELETE| Deletes a single todo

To test this api use [todo-api.postman_collection](examples/basic/todo-api.postman_collection.json)

[You can check the example Here](examples/basic/README.md)

---

## Advanced Example(Points of interest)

The advanced example uses *node-lite-router* to publish the endpoints of the api, and basically represents a points of interest api(POI).

Endpoint|verb|Description
--|---|---
/v1/points-of-interest|POST|Creates a point of interest
/v1/points-of-interest|GET|Gets all the points of interest in a paginated fashion
/v1/points-of-interest/:poi_id|PUT| Updates a point of interest
/v1/points-of-interest/:poi_id|DELETE| Deletes a point of interest
/v1/points-of-interest/:poi_id|GET| Finds a particular a point of interest

To test this api use [poi-api.postman_collection](examples/advanced/poi-api.postman_collection.json)

[You can check the example Here](examples/advanced/README.md)

# Testing

## Run all tests

To run all unit and integration tests:

```bash
npm test
```

## Run unit tests only

To run the unit tests use the following command:

```bash
npm run unit-test
```

## Run integ tests only

To run the integration tests use the following command:

```bash
npm run integ-test
```

# Generate ESDOC Documentation

To geneate the ESDOC documentation use the following command:

```bash
npm run docs
```

# Running the coverage
To run the coverage report use the following command
```bash
npm run coverage
```
---

# Why sequelize-resource-controller(My motivations)?

When writing CRUD based REST Apis with a relational database backend, you'll often find yourself loosing time with some stuff like implementing transactions, writing validations, and just every step possible to convert your database model into an Resource representation.

This module will make sure your code looks standarized and CRUD looks like a trivial thing.

This also addresses to reach the Richardson's Rest Maturity Model by implementing for you the fancy parts(Basically the Verbs, the status codes, and the Hateoas stuff).

This module also uses google API design in terms of resource responses, error handling and internal service names(with the exception of our **delete** reserved word :P).

# Notes

* This is the second module of a series of node-modules that I am creating with the main goal of creating node based microservices stacks. This will address the Relational database CRUD APi approach with some *database per service around here*.

* It was based on a module that I've previously coded back in 2016, this module has a cleaner way of doing things and has less messy parts. It allows you to take more control on some things. Also has support for restify wich is cool.

* This module was written using async/await so you it is easier to handle the tricky parts.

* This module has some cool eslinting around.

# ROADMAP

* I18N support: Will be cool and nice to have translation messages for the supported errors and responses.

* Extensible support for List endpoint: Basically override the findAll params to include associations or something like that.