Sobre • Documentação • Como usar a API • Funcionalidades • Tecnologias • Agradecimentos • Autores • Licença
Dando um "help" a Dona Maria, organizar os funcionarios e os produtos de forma que só os gerentes adicionem os produtos.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: MongoDB, Node.js e pode ser utilizado o Postman para testar as rotas, não esquecer de criar a pasta ".env' seguindo o exemp. Além disto é bom ter um editor para trabalhar com o código como VSCode
# Clone este repositório
$ git clone <https://github.com/ItaloDavidb/API_EMPLOYEE.git>
# Acesse a pasta do projeto no terminal/cmd
$ cd apiDonaMaria
# Instale as dependências
$ npm install
# Execute a aplicação
$ npm start
# O servidor inciará na porta:3000 - acesse <http://localhost:3000/api/v1> Sugestões para testar as rotas
Para cadastrar funcionarios.
POST -
http://localhost:3000/api/v1/employee
{
"name": "Maria da Silva",
"cpf": "12312312312",
"office": "gerente",
"birthday": "21/04/2021"
}Para listar funcionarios.
GET -
http://localhost:3000/api/v1/emplyee
//Exemplo de query params
{
"name": "silva",
"office": "gerente"
}
Para atualizar um funcionario.
PUT -
http://localhost:3000/api/v1/employee/:employee_id
{
"name": "maria da roberta",
"office": "funcionario",
"situation": "deactivate"
}Situation só pode ser deactivate ou activate
Para deletar um funcionario .
DELETE -
http://localhost:3000/api/v1/employee/:employee_id
Para cadastrar um produto.
Use: POST -
http://localhost:3000/api/v1/product
{
"name": "notebook dell",
"category": "eletronico",
"price": "12.32",
"employee_id": "a99e8bf7-fa32-4ae7-8b53-5e00b9d43621"
}Apenas Gerente ativo pode cadastrar um novo Produto
Para listar os produtos.
Use: GET -
http://localhost:3000/api/v1/product
{
"employee_id": "a99e8bf7-fa32-4ae7-8b53-5e00b9d43621",
"category": "eletronico",
"name": "dell",
"min_price": 10.5,
"max_price":50
}As seguintes ferramentas foram usadas na construção do projeto:
Obrigado por incentivar, por cada conselho ,"puxão de orelha" e por estar sempre por perto dando apoio e tirando todas nossas dúvidas!!
| Felipe Silva | Bruna Santos | Thais Nicodemus |
| Diego Bueno | Gabriel Missio | Giovanni Hoffmann |
Desenvolvedores e suas respectivas funções no Projeto:
| Função | Devs |
|---|---|
| P.O | Felipe Silva |
| Scrum Master | Matheus Moraes |
| Deployer | Rafael Tomás |
| QA | Pedro Menezes |
| Code review | Adson Souza |
| Code review | Italo Alves |
Todos os Devs, com excessão do P.O, atuaram no desenvolvimento da API.
Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.