- Clique no botão <> Code.
- Selecione Download ZIP.
- Descompacte o arquivo utilizando o 7ZIP ou WinRAR em uma pasta de sua escolha.
- Acesse o VS Code.
- No canto superior esquerdo, clique em File.
- Selecione Open Folder.
- Escolha a pasta onde você descompactou o arquivo.
- Abra o arquivo.
- Abra o Postman.
- Clique no Menu (canto superior esquerdo).
- Selecione File.
- Escolha Import.
- Selecione o arquivo node-prova.postman_collection.json.
- Abra o arquivo.
- Para realizar as requisições clique em SEND.
Este documento descreve as requisições disponíveis na API conforme configurado no arquivo Postman.
- host:
http://localhost:3000 - token: Token JWT usado para autenticação de rotas protegidas.
Método: GET
Endpoint: /
Descrição: Testa o funcionamento do servidor público.
Método: POST
Endpoint: /auth/register
Descrição: Registra um novo usuário.
Body:
{
"username": "Bernardo2",
"password": "Teste"
}Método: POST
Endpoint: /auth/login
Descrição: Realiza o login do usuário.
Body:
{
"username": "Asafe",
"password": "Teste"
}Método: GET
Endpoint: /user/:id
Descrição: Retorna dados do usuário autenticado.
Autenticação: Bearer Token
Exemplo de URL: /user/675cee787207036ee529fbea
Método: GET
Endpoint: /category/get
Descrição: Retorna todas as categorias cadastradas.
Método: GET
Endpoint: /category/get/:id
Descrição: Retorna os detalhes de uma categoria específica.
Exemplo de URL: /category/get/675d0a545d3698d65c9fed51
Método: POST
Endpoint: /category/post
Descrição: Insere uma nova categoria.
Body:
{
"name": "Categoria 02",
"description": "Teste 123"
}Método: PUT
Endpoint: /category/update/:id
Descrição: Atualiza uma categoria existente.
Body:
{
"description": "Teste"
}Exemplo de URL: /category/update/675d0a545d3698d65c9fed52
Método: PUT
Endpoint: /category/put/:id
Descrição: Edita uma categoria existente.
Body:
{
"name": "Gamer",
"description": "Mouse Gamer"
}Exemplo de URL: /category/put/675d0a545d3698d65c9fed52
Método: DELETE
Endpoint: /category/delete/:id
Descrição: Deleta uma categoria existente.
Exemplo de URL: /category/delete/675d0a545d3698d65c9fed52
Método: GET
Endpoint: /product/get
Descrição: Retorna todos os produtos cadastrados.
Método: GET
Endpoint: /product/get/:id
Descrição: Retorna os detalhes de um produto específico.
Exemplo de URL: /product/get/675e0c95b7281b2027c9301a
Método: POST
Endpoint: /product/post
Descrição: Insere um novo produto.
Body:
{
"name": "Produto Exemplo",
"description": "Descrição do produto",
"amount": 10,
"price": 99.99,
"id_categories": [
"675de2cd481122dda8263c9b",
"675de2ca481122dda8263c98",
"675de90959b1a64f738715da"
]
}Método: PUT
Endpoint: /product/update/:id
Descrição: Atualiza um produto existente.
Body:
{
"id_categories": [
"675de2ca481122dda8263c98","675de2cd481122dda8263c9b"
]
}Exemplo de URL: /product/update/675e0c95b7281b2027c9301a
Método: PUT
Endpoint: /product/put/:id
Descrição: Edita um produto existente.
Body:
{
"_id": "675e0c95b7281b2027c9301a",
"name": "Produto Exemplo",
"description": "Descrição do produto",
"amount": 10,
"price": 99.99,
"id_categories": [
"675de2ca481122dda8263c98",
"675de2cd481122dda8263c9b",
"675de90959b1a64f738715da"
]
}Exemplo de URL: /product/put/675dde2d38b46a34a4b98f90
Método: DELETE
Endpoint: /product/delete/:id
Descrição: Deleta um produto existente.
Exemplo de URL: /product/delete/675dddbe38b46a34a4b98f8c
Método: GET
Endpoint: /general/products/category/:id
Descrição: Retorna os produtos vinculados a uma categoria específica.
Exemplo de URL: /general/products/category/675d0a5e5d3698d65c9fed56
Método: GET
Endpoint: /general/get
Descrição: Retorna todos os produtos com as respectivas categorias.