https://github.com/romulooliveira94/digital-store-api-rest-v1
Api Rest with jwt authentication made with Node/Express for a E-commerce Website.
https://github.com/romulooliveira94/digital-store-api-rest-v1
expressjs javascript jwt sequelize sqlite
Last synced: 2 months ago
JSON representation
Api Rest with jwt authentication made with Node/Express for a E-commerce Website.
- Host: GitHub
- URL: https://github.com/romulooliveira94/digital-store-api-rest-v1
- Owner: RomuloOliveira94
- Created: 2024-08-18T22:15:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T16:22:50.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T14:47:01.905Z (about 1 year ago)
- Topics: expressjs, javascript, jwt, sequelize, sqlite
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Digital Store Api š»
Technologies ā¢
Getting Started ā¢
API Endpoints
This project is a REST API for managing products in an ecommerce store. The API manages product categories and users, and also includes authentication via jwt and route protection.
š» Technologies
- Javascript
- Express
- NodeJS
- JsonWebToken
- Sequelize
- Sqlite
š Getting started
Prerequisites
Here you list all prerequisites necessary for running your project. For example:
- [NodeJS](https://github.com/)
- [Git 2](https://github.com)
Cloning
How to clone your project
```bash
git clone https://github.com/RomuloOliveira94/digital-store-api-rest-v1
```
Config .env variables
Use the `.env.example` as reference to create your configuration file `.env`
```yaml
PORT=3000
JWT_SECRETE=example
```
Starting
```bash
cd digital-store-api-rest-v1
npm install
node --run dev or npm run dev
```
š API Endpoints
User Routes
GET api/user/register
**REQUEST**
```json
{
"firstname": "teste",
"surname": "teste",
"email": "test@test.com"
}
```
**RESPONSE**
```json
{
"firstname": "teste",
"surname": "teste",
"email": "test@test.com"
}
```
POST api/user/token
**REQUEST**
```json
{
"email": "test@test.com",
"password": "test123"
}
```
**RESPONSE**
```json
{
"token": "OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi"
}
```
GET api/user
**RESPONSE**
```json
[
{
"id": 1,
"firstname": "teste2",
"surname": "teste2",
"email": "user2@mail.com"
},
{
"id": 3,
"firstname": "teste4",
"surname": "teste4",
"email": "user4@mail.com"
},
{
"id": 4,
"firstname": "mudei carai",
"surname": "teste4",
"email": "user4@mail.com"
},
{
"id": 5,
"firstname": "teste4",
"surname": "teste4",
"email": "user4@mail.com"
}
]
```
GET api/user/1
**RESPONSE**
```json
{
"firstname": "teste",
"surname": "teste",
"email": "test@test.com"
}
```
PUT api/user/1
**REQUEST**
```json
{
"firstname": "teste2",
"password: "112233"
}
```
**RESPONSE**
```json
{
"firstname": "teste2",
"surname": "teste",
"email": "test@test.com"
}
```
DELETE api/user/1
**RESPONSE**
```json
{
"message": "UsuƔrio deletado com sucesso"
}
```
Product Routes
GET /api/product/search
Params:
- limit (int)
- page (int)
- fields (string)
- match (string)
- category_ids (string)
- price_range (string)
- option (string)
**REQUEST**
/api/product/search?limit=-1&page=1&fields=name&match=produto1&price_range=0-100&category_ids=1,2&option=GG,PP
**RESPONSE**
```json
{
"data": [
{
"name": "Produto 01",
"categories": [
{
"id": 1,
"name": "teste 1",
"slug": "teste-1",
"use_in_menu": false,
"createdAt": "2024-08-18T23:22:45.453Z",
"updatedAt": "2024-08-18T23:22:45.453Z",
"category_product": {
"createdAt": "2024-08-18T23:34:02.304Z",
"updatedAt": "2024-08-18T23:34:02.304Z",
"productId": 10,
"categoryId": 1
}
}...
],
"images": [
{
"id": 11,
"enabled": false,
"url": "base64 da imagem 2",
"createdAt": "2024-08-18T23:34:02.278Z",
"updatedAt": "2024-08-18T23:34:02.278Z",
"productId": 10
}...
],
"product_options": [
{
"id": 1,
"title": "Cor",
"shape": "square",
"radius": "4px",
"type": "text",
"values": "PP, GG, M",
"createdAt": "2024-08-18T23:34:02.279Z",
"updatedAt": "2024-08-18T23:34:02.279Z",
"productId": 10
}
]
},
...
],
"limit": "-1",
"page": "1",
"total": 2
}
```
GET /api/product/1
**RESPONSE**
```json
{
"id": 7,
"enabled": true,
"name": "Produto 01",
"slug": "produto-01",
"use_in_menu": false,
"stock": 10,
"description": "DescriĆ§Ć£o do produto 01",
"price": 120,
"price_with_discount": 99.9,
"createdAt": "2024-08-18T23:31:23.898Z",
"updatedAt": "2024-08-18T23:31:23.898Z",
"categories": [
{
"id": 1,
"name": "teste 1",
"slug": "teste-1",
"use_in_menu": false,
"createdAt": "2024-08-18T23:22:45.453Z",
"updatedAt": "2024-08-18T23:22:45.453Z",
"category_product": {
"createdAt": "2024-08-18T23:31:23.928Z",
"updatedAt": "2024-08-18T23:31:23.928Z",
"productId": 7,
"categoryId": 1
}
},
{
"id": 2,
"name": "teste 2",
"slug": "teste-2",
"use_in_menu": true,
"createdAt": "2024-08-18T23:22:47.543Z",
"updatedAt": "2024-08-18T23:22:47.543Z",
"category_product": {
"createdAt": "2024-08-18T23:31:23.928Z",
"updatedAt": "2024-08-18T23:31:23.928Z",
"productId": 7,
"categoryId": 2
}
}
],
"images": [
{
"id": 2,
"enabled": false,
"url": "base64 da imagem 2",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
},
{
"id": 3,
"enabled": false,
"url": "base64 da imagem 3",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
},
{
"id": 1,
"enabled": true,
"url": "base64 da imagem 1",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
}
],
"product_options": []
}
```
POST /api/product
**REQUEST**
```json
{
"enabled": true,
"name": "Produto 01",
"slug": "produto-01",
"stock": 10,
"description": "DescriĆ§Ć£o do produto 01",
"price": 119.90,
"price_with_discount": 99.90,
"categories": [1,2],
"images": [
{
"enabled": true,
"url": "base64 da imagem 1"
},
{
"enabled": false,
"url": "base64 da imagem 2"
},
{
"enabled": false,
"url": "base64 da imagem 3"
}
],
"product_options": [
{
"title": "Cor",
"shape": "square",
"radius": "4px",
"type": "text",
"values": "PP, GG, M"
},
{
"title": "Tamanho",
"shape": "circle",
"type": "color",
"values": "#000, #333"
}
]
}
```
**RESPONSE**
```json
{
"id": 7,
"enabled": true,
"name": "Produto 01",
"slug": "produto-01",
"use_in_menu": false,
"stock": 10,
"description": "DescriĆ§Ć£o do produto 01",
"price": 120,
"price_with_discount": 99.9,
"createdAt": "2024-08-18T23:31:23.898Z",
"updatedAt": "2024-08-18T23:31:23.898Z",
"categories": [
{
"id": 1,
"name": "teste 1",
"slug": "teste-1",
"use_in_menu": false,
"createdAt": "2024-08-18T23:22:45.453Z",
"updatedAt": "2024-08-18T23:22:45.453Z",
"category_product": {
"createdAt": "2024-08-18T23:31:23.928Z",
"updatedAt": "2024-08-18T23:31:23.928Z",
"productId": 7,
"categoryId": 1
}
},
{
"id": 2,
"name": "teste 2",
"slug": "teste-2",
"use_in_menu": true,
"createdAt": "2024-08-18T23:22:47.543Z",
"updatedAt": "2024-08-18T23:22:47.543Z",
"category_product": {
"createdAt": "2024-08-18T23:31:23.928Z",
"updatedAt": "2024-08-18T23:31:23.928Z",
"productId": 7,
"categoryId": 2
}
}
],
"images": [
{
"id": 2,
"enabled": false,
"url": "base64 da imagem 2",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
},
{
"id": 3,
"enabled": false,
"url": "base64 da imagem 3",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
},
{
"id": 1,
"enabled": true,
"url": "base64 da imagem 1",
"createdAt": "2024-08-18T23:31:23.910Z",
"updatedAt": "2024-08-18T23:31:23.910Z",
"productId": 7
}
],
"product_options": []
}
```
PUT /api/product/1
**REQUEST**
```json
{
"enabled": true,
"name": "Produto 3",
"slug": "produto-03",
}
```
**RESPONSE**
```json
{
"id": 1,
"enabled": true,
"name": "Produto 3",
"slug": "produto-03",
"use_in_menu": false,
"stock": 10,
"description": "DescriĆ§Ć£o do produto 01",
"price": 20,
"price_with_discount": 99.9,
"createdAt": "2024-08-18T23:18:56.176Z",
"updatedAt": "2024-08-19T16:13:24.184Z"
}
```
DELETE /api/product/1
```json
{ "message": "Produto deletado com sucesso" }
```
Category Routes
GET /api/category/search
Params:
- limit (int)
- page (int)
- fields (string)
- use_in_menu (boolean)
**REQUEST**
/api/category/search?limit=3&page=1&fields=name
**RESPONSE**
```json
{
"data": [
{
"name": "teste 1"
},
{
"name": "teste 2"
},
{
"name": "teste 3"
}
],
"limit": "3",
"page": "1",
"total": 3
}
```
GET /api/category/1
**RESPONSE**
```json
{
"id": 1,
"name": "teste 1",
"slug": "teste-1",
"use_in_menu": true,
"createdAt": "2024-08-18T23:22:45.453Z",
"updatedAt": "2024-08-18T23:22:45.453Z"
}
```
POST /api/category
**REQUEST**
```json
{
"id": 6,
"name": "teste 5",
"slug": "teste-5",
"use_in_menu": true
}
```
**RESPONSE**
```json
{
"id": 6,
"name": "teste 5",
"slug": "teste-5",
"use_in_menu": true,
"updatedAt": "2024-08-19T14:10:46.514Z",
"createdAt": "2024-08-19T14:10:46.514Z"
}
```
PUT /api/category/1
**REQUEST**
```json
{
"id": 6,
"name": "teste 5.1",
"slug": "teste-5",
"use_in_menu": false
}
```
**RESPONSE**
```json
{
"id": 6,
"name": "teste 5.1",
"slug": "teste-5",
"use_in_menu": false,
"updatedAt": "2024-08-19T14:10:46.514Z",
"createdAt": "2024-08-19T14:10:46.514Z"
}
```
DELETE /api/category/1
```json
{ "message": "Categoria deletada com sucesso" }
```