Talker Manager

Talker Manager foi proposto como uma atividade de aprimoramento dos meus estudos sobre desenvolvimento de API. O projeto me permitiu colocar em prática o que aprendi sobre Node.js, Express.js, JWT e Protocolos HTTP durante o módulo Back-end na Trybe.

Objetivo

Desenvolver uma API CRUD (Criar, Ler, Atualizar e Deletar) de palestrantes, que possui um token necessário para acessar os demais endpoints que permite o usuário interagir. As informações precisam ser gravadas em um arquivo JSON, usando os Core Modules do Node.js.

Tecnologias e Ferramentas

Na elaboração da API RESTful, tentei organizar o projeto com a arquitetura MSC (Model-Service-Controller), mesmo não existindo uma model, já que os dados armazenados da API fica em arquivo JSON.

⚙️ Execução

Clique para expandir!

Para executar a aplicação inicie realizando o clone deste repositório com o comando abaixo.

git clone git@github.com:guilhermepallma/talker-manager.git

Navegue até a raíz do projeto.

cd talker-manager/

Na raíz do projeto execute o comando abaixo para instalar as dependências.

npm install

Para subir o servidor com o nodemon utilize o comando abaixo no terminal dentro do projeto.

npm run dev

Documentação da API

Clique para expandir!

Retorna o token necessário para acessar os demais endpoints da API.

  POST /login

Exemplo de valores:

{
  "email": "email@email.com",
  "password": "123456"
}

Retorna todos os palestrantes cadastrados.

  GET /talker

Retorna um palestrante pelo id.

  GET /talker/:id

Parâmetro	Tipo	Descrição
id	number	Obrigatório. O ID do palestrante que deseja retorna.

Retorna um palestrante pelo nome.

  GET /talker/search?q=searchTerm

Parâmetro	Tipo	Descrição
searchTerm	string	Obrigatório. O nome que deseja retorna.

Cadastra um novo palestrante.

  POST /talker

Exemplo de valores:

{
  "name": "Gabigol",
  "age": 25,
  "talk": {
    "watchedAt": "28/10/2022",
    "rate": 3
  }
}

Atualiza os dados de um palestrante cadastrado.

  PUT /talker/:id

Parâmetro	Tipo	Descrição
id	number	Obrigatório. O ID do palestrante que deseja atualizar.

OBS: Os valoes que podem ser editados, são os mesmo necessários para cadastrar.

Retorna um palestrante pelo nome.

  DELETE /talker/:id

Parâmetro	Tipo	Descrição
id	number	Obrigatório. O ID do palestrante que deseja DELETAR.

Desenvolvido por Guilherme Palma © 2022.