product-web-api-knex's Introduction

Product REST API

Uma api REST em Express com as operações básicas de CRUD.

Tech Stack

Server: Node, Express, Express-Validator

Banco de Dados: PostgreSQL

Requisitos

Para executar o projeto localmente, é necessário ter o PostgreSQL e o Node JS instalados no computador.

No arquivo src/configs/database.js, substituia os valores da string de conexão postgres://local_user:local_user_password/database_name com os dados do seu banco de dados local.

Instalação e execução local

Descompacte a pasta com o código do projeto.

 cd product_web_api
 npm install
 npm run dev

Referência da API

Lista todos os produtos

  GET /api/v1/product

Obtém um produto

  GET /api/v1/product/:productId

Parameter	Type	Description
`productId`	`int`	Required. Id do produto para ser obtido

Deleta um produto

  DELETE /api/v1/product/:productId

Parameter	Type	Description
`productId`	`int`	Required. Id do produto para ser deletado

Cria um produto

  POST /api/v1/product

Body	Type	Description
`description`	`string`	Required. Texto descrevendo o produto, ou nome
`brand`	`string`	Required. Marca do produto
`value`	`float`	Required. Preço do produto

Edita um produto

  PUT /api/v1/product/:productId

Parameter	Type	Description
`productId`	`int`	Required. Id do produto para ser editado

Body	Type	Description
`description`	`string`	Required. Texto descrevendo o produto, ou nome
`brand`	`string`	Required. Marca do produto
`value`	`float`	Required. Preço do produto

Recommend Projects