🚚
API Transportadora
Projeto de encerramento do módulo 4 da Resilia Educação. O objetivo é desenvolver uma API Rest de uma transportadora.
📮
Pré-requisitos
📨
Iniciando da aplicação
Rode os comandos a seguir no terminal ou PoweShell.
- Clone o repositório:
git clone https://github.com/Ands1776/API-Rest-Transportadora.git
- Acesse a pasta:
cd API-Rest-Transportadora
- Instale os pacotes necessários:
npm install
- Popule o banco de dados:
npm run populate
- Inicie o servidor:
npm run start
Ao iniciar o projeto, o servidor será aberto em http://localhost:3000/, sendo 3000 a porta padrão. Caso necessário, a porta poderá ser alterada no arquivo server.js
📦
Rotas HTTP
GET /pedidos
Lista todos os pedidos da base de dados. Exemplo da resposta esperada:
{
"pedido": [
{
"ID": 1,
"enderecos_id": 1,
"status_id": 1,
"pacote_id": 1,
"opcoes_de_entrega": "Correio"
}
],
"erro": false
}
GET /pedidos/id/:id
Retorna o pedido de acordo com o id. Campo ":id" deverá ser substituído pelo id do pedido escolhido. Exemplo da resposta esperada:
{
"pedido": {
"ID": 1,
"enderecos_id": 1,
"status_id": 1,
"pacote_id": 1,
"opcoes_de_entrega": "Correio"
},
"erro": false
}
POST /pedidos
Insere um novo pedido na base de dados.
Exemplo da resposta esperada:
{
"mensagem": "Pedido efetuado com sucesso!",
"pedido": {
"enderecos_id": 7,
"status_id": 7,
"pacote_id": 7,
"opcoes_de_entrega": "Sedex"
},
"erro": false
}
PUT /pedidos/id/:id
Atualiza um pedido na base de dados. Campo ":id" deverá ser substituído pelo id do pedido a ser atualizado.
Exemplo da resposta esperada:
{
"mensagem": "Pedido de id 7 atualizado com sucesso",
"pedido": {
"opcoes_de_entrega": "Retirada no local"
},
"erro": false
}
DELETE /pedidos/id/:id
Deleta o pedido escolhido da base de dados. Exemplo da resposta esperada:
{
"pedido": "Pedido deletado com sucesso!",
"erro": false
}
🚛
Desenvolvido por
Anderson da Cunha Vidal 👨🏾💻
Estudante de Desenvolvimento Web Full Stack.