https://github.com/stefanluks/niceplanet-backend
Desafio de simular a criação de uma API que possibilita à indústria cadastrar os produtores e as propriedades de sua carteira de clientes para serem monitoradas pela Niceplanet.
https://github.com/stefanluks/niceplanet-backend
mysql-database node-sequelize nodejs nodejs-backend
Last synced: 8 months ago
JSON representation
Desafio de simular a criação de uma API que possibilita à indústria cadastrar os produtores e as propriedades de sua carteira de clientes para serem monitoradas pela Niceplanet.
- Host: GitHub
- URL: https://github.com/stefanluks/niceplanet-backend
- Owner: stefanluks
- Created: 2023-05-15T19:06:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-17T19:28:36.000Z (almost 3 years ago)
- Last Synced: 2025-06-02T09:29:38.967Z (10 months ago)
- Topics: mysql-database, node-sequelize, nodejs, nodejs-backend
- Language: HTML
- Homepage:
- Size: 74.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Teste para desenvolvedor Back-end
Projeto desenvolvido para um desafio da niceplanet objetivo de realizar o desafio de simular a criação de uma API que possibilita à indústria cadastrar os produtores e as propriedades de sua carteira de clientes para serem monitoradas pela Niceplanet.
>ESPECIFICAÇÕES TÉCNICAS: Node JS, Mysql
> utilizando as bibliotecas node: express, jsonwebtoken, mysql2 e sequelize.
## Executando o projeto
>Para fazer o clone do projeto utilize o comando no terminal:
git clone https://github.com/stefanluks/Niceplanet-Backend.git
### 1º `cd Niceplanet-Backend`
Executando o comando para acessar a pasta do projeto.
### 2º `npm install`
Para instalar todas as bibliotecas do JS necessarios para o projeto, e em seguida execute.
### 3º `npm start`
Irá executar o projeto em modo de desenvolvimento.\
Que pode ser testado no navegador no endereço: [http://localhost:8080](http://localhost:8080)
## Rotas do sistema
/login **POST**
---------------
http://localhost:8080/login
Para acessar as demais rotas é necessario está autenticado no sistema, e para isso é feito uma requesição do tipo **POST**
Deve ser enviado um **Json** com os dados do usuario que deseja entrar, por exemplo:
```json
{
"nomeUsuario":"Stefan Lucas",
"senhaUsuario": "slas@123#"
}
```
Com isto o sistema deve retornar a confirmação da efetuação do login, passando um token para o acesso.
```json
{
"error": false,
"mensagem": "Login Realizado!!",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NSwiaWF0IjoxNjg0MTczMTAwLCJleHAiOjE2ODQ0MzIzMDB9.366XFWtNdpoBcBwP18OtePtrUNoYadDqsqEZyVztd00"
}
```
Este **Token** deve ser passado para a aplicação no cabeçalho no **Bearer** para validar a autenticação no sistema.
----
/cadastrar **POST**
-------------------
http://localhost:8080/cadastrar
Para cadastrar um novo usuário no sistema deve ser feito atráves dessa rota executando uma requesição do tipo **POST**
Deve ser enviado um **Json** com os dados do usuario que deseja cadastrar, por exemplo:
```json
{
"nomeUsuario":"Stefan Silva",
"senhaUsuario": "slas@123#"
}
```
Com isto o sistema deve retornar a confirmação do cadastro no banco de dados.
```json
{
"error": false,
"mensagem": "cadastrado com sucesso!"
}
```
----
/AddProdutorPropriedade **POST**
--------------------------------
http://localhost:8080/AddProdutorPropriedade
Nesta rota é executado uma requesição do tipo **POST** para adicionar nos produtores ou propriedades
Para isso deve ser enviado um **Json** com os dados que deseja cadastrar, exemplo:
### Cadastrando Os dois Objetos
```json
{
"produtor":{
"nomeProdutor":"Stefan Lucas",
"cpfProdutor":"03851345177"
}, "propiedade":{
"nomePropriedade":"Chacara SL",
"cadastroRural":"00XX0115322247C65"
}
}
```
É possivel também cadastrar individualmente os itens, por exemplo o cadastrar apenas do produtor passando seus atributos:
### Cadastrando apenas o Produtor
```json
{
"produtor":{
"nomeProdutor":"Stefan Lucas",
"cpfProdutor":"03851345177"
}
}
```
Sendo possivel tambem o cadastro apenas da propriedade passando apenas os dados dela:
### Cadastrando apenas a Propriedade
```json
{
"propiedade":{
"nomePropriedade":"Chacara SL",
"cadastroRural":"00XX0115322247C65"
}
}
```
----
/Get/idProdutor-idPropriedade **GET**
-------------------------------------
http://localhost:8080/Get/{idProdutor-idPropriedade}
Nesta rota um usuário autenticado pode fazer uma requisição do tipo **GET** no bando de dados atráves da API. É possível buscar por um produtor e/ou propriedade pelos seus id's.
Para isso o usuário deve passar como parâmentro esses ids separados por um um hifén, Por exemplo:
---
## buscando por um Produtor
``http://localhost:8080/Get/22``
O sistema deve retornar um json com os dados do produtor caso exista no banco de dados.
```json
{
"idProdutor":22,
"nomeProdutor":"Stefan Lucas",
"cpfProdutor":"03851345177"
}
```
E para buscar apenas uma propriedade é possível adicionando um hifén antes do id, por exemplo:
---
## buscando por uma Propriedade
``http://localhost:8080/Get/-4``
O sistema deve retornar um json com os dados do propriedade caso exista no banco de dados.
```json
{
"idPropriedade":4,
"nomePropriedade":"Terra dos sonhos",
"cadastroRural":"01XX4563222472345"
}
```
E para buscar ambos deve ser seguir a ordem de idProdutor seguido de hifén e por fim o idPropriedade.
---
## buscando por um produtor e uma propriedade
``http://localhost:8080/Get/22-4``
O sistema deve retornar um json com os dados do produtor e da propriedade caso existam no banco de dados.
```json
{
"produtor":{
"idProdutor":22,
"nomeProdutor":"Stefan Lucas",
"cpfProdutor":"03851345177"
},
"propriedade":{
"idPropriedade":4,
"nomePropriedade":"Terra dos sonhos",
"cadastroRural":"01XX4563222472345"
}
}
```