CHANGELOG API

Este aplicativo permite que um gerente de produto ou engenheiro publique atualizações de produtos para seus usuários.

O design demonstra a interface gráfica do aplicativo.

---

Funcionalidades

• Sistema de autenticação com usuário e senha
• Gerenciar projetos
• Gerenciar atualizações

Stack utilizada

Front-end (Em construção): React, Tailwind, Zustand, React-Query

Back-end: Node,Typescript, Express, Prisma

Variáveis de Ambiente

Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu .env

DATABASE_URL

PORT

TOKEN_SECRET

NODE_ENV

Documentação da API

MODULO DE USUÁRIOS

Cria um novo usuário

  POST /api/auth/signup

Parâmetro	Tipo	Descrição
username	string	Obrigatório. Nome utilizado na autenticação do usuário
password	string	Obrigatório. Senha utilizada para autenticação

Autentica o usuário

  POST /api/auth/signin

Parâmetro	Tipo	Descrição
username	string	Obrigatório. nome de usuário
password	string	Obrigatório. senha do usuário

Retorna o usuário autenticado

  GET /api/auth/me

Parâmetro	Tipo	Descrição
headers	Bearer token	Obrigatório Token recebido na autenticação

Atualiza informações do usuário autenticado

  PUT /api/auth/update

Parâmetro	Tipo	Descrição
username	string	Opicional. nome de usuário
password	string	Opicional. senha do usuário
headers	Bearer token	Obrigatório Token recebido na autenticação

Exclui o usuário

  DELETE /api/auth/delete

Parâmetro	Tipo	Descrição
headers	Bearer token	Obrigatório Token recebido na autenticação

MODULO DE PRODUTOS

Criação de um novo produto

POST /api/products/new

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do produto
headers	Bearer token	Obrigatório. Token recebido na autenticação

Listagem de produtos

GET /api/products

Parâmetro	Tipo	Descrição
headers	Bearer token	Obrigatório. Token recebido na autenticação

Obtenção de um produto específico

GET /api/products/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do produto
headers	Bearer token	Obrigatório. Token recebido na autenticação

Atualização de um produto

PUT /api/products/update/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do produto
name	string	Obrigatório. Nome do produto
headers	Bearer token	Obrigatório. Token recebido na autenticação

Deleção de um produto

DELETE /api/products/delete/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do produto
headers	Bearer token	Obrigatório. Token recebido na autenticação

MODULO DE ATUALIZAÇÕES

Criação de uma nova atualização

POST /api/update/new/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do produto
title	string	Obrigatório. Título da atualização
version	string	Obrigatório. Versão da atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Listagem de atualizações de um produto

GET /api/update/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do produto
headers	Bearer token	Obrigatório. Token recebido na autenticação

Obtenção de uma atualização específica

GET /api/update/product/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID da atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Atualização de uma atualização

PUT /api/update/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID da atualização
title	string	Obrigatório. Título da atualização
version	string	Obrigatório. Versão da atualização
status	string	Opcional. Status da atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Deleção de uma atualização

DELETE /api/update/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID da atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

MODULO DE BULLET POINTS (NODES) DE ATUALIZAÇÃO

POST /api/updatepoints/new

Parâmetro	Tipo	Descrição
name	string	Obrigatório. Nome do ponto de atualização
description	string	Opcional. Descrição do ponto de atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Listagem de pontos de atualização de uma atualização

GET /api/updatepoints/update/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID da atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Obtenção de um ponto de atualização específico

GET /api/updatepoints/update/point/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do ponto de atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Atualização de um ponto de atualização

PUT /api/updatepoints/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do ponto de atualização
name	string	Obrigatório. Nome do ponto de atualização
description	string	Opcional. Descrição do ponto de atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação

Deleção de um ponto de atualização

DELETE /api/updatepoints/:id

Parâmetro	Tipo	Descrição
id	string	Obrigatório. ID do ponto de atualização
headers	Bearer token	Obrigatório. Token recebido na autenticação