CRUD-NodeJS-Sequelize-Swagger-MySQL

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #llm #go #android #deep-learning #nodejs #java #windows #awesome #ios #openai

CRUD-NodeJS-Sequelize-Swagger-MySQL

(★ 15)

Simple CRUD example with NodeJS, Sequelize, Swagger and MySQL

CRUD-NodeJS-Sequelize-Swagger-MySQL Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/titulo.JPG)

# CRUD-NodeJS-Sequelize-Swagger-MySQL

Simple CRUD example with NodeJS, Sequelize, Swagger and MySQL

## Technologies:

- NodeJS Express v4.16.4
- Sequelize v4.38.0
- Swagger UI v3.20.1
- MySQL

## Objective

The objective of this guide is to make a [NodeJS Express](https://expressjs.com/pt-br/) web API connecting with a [MySQL](https://dev.mysql.com/downloads/installer/) database by using the [Sequelize ORM](https://sequelize.org/) (Object-relational mapping). The [Swagger UI](https://swagger.io/tools/swagger-ui/) will be used to test the API.

## To run this project

- Run the script located at "/docs/crud.sql" to create the database on MySQL Workbench or on another program of your preference.

- Install the node modules running the comands below at the root folder:

```batch
    npm install
```

- Run the API:

```batch
    npm run dev
```

- Acess the URL:

```batch
    http://localhost:3000
```

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/swagger.JPG)

## How it works

The structure of the project is this:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node01.JPG)

The "server.js" file creates a MySQL pool to allow multiple connections:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node02.JPG)

The "/config/config.json" contains database connections for different environments. They are used by the "/models/index.js" file during the Sequelize initialization:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node03.JPG)

The "/models" folder contains the Sequelize table models. For example: the "profiles" model.

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node04.JPG)

The "users" model makes reference to the "profiles" model:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node05.JPG)

The "/plugins/transaction.js" file is responsible for making the transaction's commit and rollback:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node06.JPG)

The "/controllers/users.js" has the GET/POST/PUT/DELETE methods:

![Alt Text](https://raw.githubusercontent.com/lucianopereira86/CRUD-NodeJS-Sequelize-Swagger-MySQL/master/docs/node07.JPG)

CRUD-NodeJS-Sequelize-Swagger-MySQL

CRUD-NodeJS-Sequelize-Swagger-MySQL Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

CRUD-NodeJS-Sequelize-Swagger-MySQL

CRUD-NodeJS-Sequelize-Swagger-MySQL Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README