Esta es una Api simula una parte del funcionamiento de una aplicación web e-commerce. La Api se encarga de agregar e iliminar productos y autenticar ususarios, tambien validar usuarios y sus roles. Toda la Api esta programada con Typescript
Server: Node, Express, Bycript, JWT, Boom, Joi, ts-node, mongoose Lenguages: Javascript, Typescript Data Base: MongoDb
Instalación de las dependencias con npm
npm install
npm run dev
npm start
- Variable que contiene el link para conectar con la base de datos
URLDB
- Palabra para generar hash de JWT
WORD
- Header para dar permiso del uso de la api
CABEZA
Base de las rutas
/api/v1
Header | Argumento |
---|---|
Content-Type | application/json |
entrada | CABEZA (Variable de entorno) |
GET /api/v1/products
Patametro | Tipo |
---|---|
_id | String |
name | String |
price | Number |
stoke | Boolean |
image | String |
category | String |
description | String |
GET /category/:category
GET /category/:id
DELETE /api/v1/products/:id
Patametro | Tipo |
---|---|
message | String |
POST /api/v1/products/
Body Request
Patametro | Tipo | Requerido | Default value |
---|---|---|---|
name | String | ✔ | - |
price | Number | ✔ | - |
stoke | Boolean | - | True |
image | String | ✔ | - |
category | String | ✔ | - |
description | String | ✔ | - |
PATCH /api/v1/products/:id
Elementos que se puede editar
Patametro | Tipo |
---|---|
name | String |
price | Number |
stoke | Boolean |
image | String |
category | String |
description | String |
GET /api/v1/users/
Patametro | Tipo |
---|---|
_id | String |
user | String |
String | |
password | String |
role | Boolean |
products | Array[string] |
POST /api/v1/users/agregar
Body request
Patametro | Tipo | Requerido | Default value |
---|---|---|---|
user | String | ✔ | - |
String | ✔ | - | |
password | String | ✔ | - |
role | Boolean | - | False |
POST /api/v1/users/inicio
Body Request
Patametro | Tipo |
---|---|
user | String |
String | |
password | String |
Patametro | Tipo |
---|---|
preinicio | String |
Response
Patametro | Tipo |
---|---|
pase | boolean |
user | String |
String | |
password | String |
POST /api/v1/users/carrito
Body
Patametro | Tipo |
---|---|
codigo | String |
carrito | Array[String] |