Sobre • Documentação • Como usar a API • Teste de Rotas • Tecnologias • Agradecimentos • Autores •
A Api Possui um Deploy no Heroku
As seguintes ferramentas foram usadas na construção do projeto:
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas, Ou pode utilizar o Swaggerque está no Heroku para testar.
MongoDB, Node.js e pode ser utilizado o Postman para testar as rotas,
não esquecer de criar a pasta ".env' seguindo o exemplo.
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_COMPASSOLISA.gitt>
# Acesse a pasta do projeto no terminal/cmd
$ cd API_COMPASSOLISA
# Instale as dependências
$ npm i
# Execute a aplicação
$ npm start
# O servidor inciará na porta:3000 - acesse <http://localhost:3000/api/v1>
Sugestões para testar as rotas
Lembrar que para se consumir da Rota de Veículos é necessário antes se Autenticar na rota de Autenticação e utilizar o Token Bearer
Para Autenticar uma Pessoa.
Use: POST -
http://localhost:3000/api/v1/people/authenticate
{
"email": "joazinho@email.com",
"senha": "123456"
}
Para cadastrar Veiculos.
POST -
http://localhost:3000/api/v1/car
{
"modelo": "GM S10 2.8",
"cor": "branco",
"ano": "2021",
"acessorios": [
{ "descricao": "Ar-condicionado" },
{ "descricao": "Dir. Hidráulica" },
{ "descricao": "Cabine Dupla" },
{ "descricao": "Tração 4x4" },
{ "descricao": "4 portas" },
{ "descricao": "Diesel" },
{ "descricao": "Air bag" },
{ "descricao": "ABS" }
],
"quantidadePassageiros": 5
}
Para listar Veiculos.
GET -
http://localhost:3000/api/v1/car
//Exemplo de query params
{
"modelo": "GM S10 2.8",
"cor": "branco",
"ano": "2021",
"acessorios": [
{ "descricao": "Ar-condicionado" },
{ "descricao": "Dir. Hidráulica" },
{ "descricao": "Cabine Dupla" },
{ "descricao": "Tração 4x4" },
{ "descricao": "4 portas" },
{ "descricao": "Diesel" },
{ "descricao": "Air bag" },
{ "descricao": "ABS" }
],
"quantidadePassageiros": 5
}
Para atualizar um Veiculo.
PUT -
http://localhost:3000/api/v1/car/:car_id
{
"modelo": "GM S10 2.8",
"cor": "branco",
"ano": "2021",
"acessorios": [
{ "descricao": "Ar-condicionado" },
{ "descricao": "Dir. Hidráulica" },
{ "descricao": "Cabine Dupla" },
{ "descricao": "Tração 4x4" },
{ "descricao": "4 portas" },
{ "descricao": "Diesel" },
{ "descricao": "Air bag" },
{ "descricao": "ABS" }
],
"quantidadePassageiros": 5
}
Para atualizar um acessorio de algum Veiculo.
PUT -
http://localhost:3000/api/v1/car/:car_id/acessorios/:acessorio_id
{ "descricao": "Ar-condicionado" },
Para deletar um Veiculo .
DELETE -
http://localhost:3000/api/v1/car/:car_id
Para cadastrar uma Pessoa.
Use: POST -
http://localhost:3000/api/v1/people
{
"nome": "joaozinho ciclano",
"cpf": "131.147.860-49",
"data_nascimento": "03/03/2021",
"email": "joazinho@email.com",
"senha": "123456",
"habilitado": "sim"
}
habilitado só permite sim ou não
Para listar Pessoas.
Use: GET -
http://localhost:3000/api/v1/people
{
"nome": "joaozinho ciclano",
"cpf": "131.147.860-49",
"data_nascimento": "03/03/2021",
"email": "joazinho@email.com",
"senha": "123456",
"habilitado": "sim"
}
Para atualizar uma Pessoa.
Use: PUT -
http://localhost:3000/api/v1/people/:people_id
{
"nome": "joaozinho ciclano",
"cpf": "131.147.860-49",
"data_nascimento": "03/03/2021",
"email": "joazinho@email.com",
"senha": "123456",
"habilitado": "sim"
}
Para excluir uma Pessoa.
Use: DELETE - `http://localhost:3000/api/v1/people/:people_id``
Para cadastrar Locadoras.
POST -
http://localhost:3000/api/v1/rental
{
"nome": "Condado",
"cnpj": "00249504000140",
"atividades": "Festas",
"endereco": [
{
"cep": "29175735",
"number": "13",
"isFilial": false
}
]
}Para listar Locadoras.
GET -
http://localhost:3000/api/v1/rental
{
"_id": "string",
"nome": "string",
"cnpj": "string",
"atividades": "string",
"endereco": [
{
"cep": "string",
"logradouro": "string",
"complemento": "string",
"bairro": "string",
"number": 0,
"localidade": "string",
"uf": "string",
"isFilial": "string"
}
]Para atualizar um Locadora.
PUT -
http://localhost:3000/api/v1/rental/:loc_id
{
"nome": "Mordor",
"cnpj": "25691722000160",
"atividades": "Morada",
"endereco": [
{
"cep": "49085195",
"number": "132",
"isFilial": true
}
]
}Para deletar uma Locadora .
DELETE -
http://localhost:3000/api/v1/rental/:loc_id
Obrigado por incentivar, por cada conselho ,"puxão de orelha" e por estar sempre por perto dando apoio e tirando todas as dúvidas de Todo o PG!!
| Felipe Silva | Bruna Santos | Thais Nicodemus |
| Diego Bueno | Gabriel Missio | Giovanni Hoffmann |
Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.