malcodaniel / desafio-eldorado Goto Github PK

Few lines describing your project.

• Sobre
• Rodando Projeto
• Exemplos

Renomeie o arquivo .env.sample para .env e substitua as variáveis de ambiente dentro do aquivo com as credenciais do banco de dados.

cp .env.sample .env

Na pasta raiz do projeto, rode:

npm install

npm run createdb
npm run migrate
npm run seed

npm run dev

A API segue o modelo REST, utilizando um endpoint para cada entidade do sistema.

Para cadastros e consulta de dispositivos, no caso de cadastro(POST); ao menos 3 campos são obrigatórios categoryId, color e partNumber exemplo:

{
	"categoryId":"2",
	"color":"orange",
	"partNumber":"10"
}

É importante lembrar que a categoria já deve existir antes do cadastro do dispositivo.

Para cadastro(POST) das categorias, esse end-point exige apenas um parâmetro name exemplo:

{
	"name":"SmartPhone"
}

Caso procure por um determinado device ou category, passe seu id como parâmetro dentro da url, exemplo: /device/3 ou /category/2