ThVinicius / tweteroo-spring

Tweteroo é uma API REST de mensagem por chat construido com Spring

Tweteroo-Spring-Boot

Tweteroo

Built With

Sumário

• Descrição
• Deploy
• FrontEnd do projeto
• Documentação da API
  • Rota de autenticação
    • Acessar o chat
  • Rotas dos tweets
    • Enviar um tweet
    • Buscar todos os tweets
    • Buscar todos os tweets de um usuário
• Rodar com docker

Descrição

Tweteroo é uma API de chat simples.

Funções

• Acessar o chat
• Mandar uma mensagem
• Visualizar todas as mensagens enviadas
• Visualizar todas as mesnsagens enviadas de um usário específico.

Deploy

• Link Deploy

FrontEnd do projeto

Na pasta raiz do projeto encontra-se o frontEnd: frontEnd - tweteroo.zip

• Para utilizá-lo faça os seguintes passos:
  • descompacte o arquivo
  • entre na pasta do arquivo e inicie o comando para instalar as dependências
    • npm install
  • inicie o servidor com o comando
    • npm run dev
    • o servidor ficará disponível no endereço: http://localhost:1234

Documentação da API

Rota de autenticação

Acessar o chat

POST /sign-up

Request:

Enviar no body da requisição

Params	Type	Description
username	string	Required, trim
avatar	string	Required, trim

Response:

Em caso de sucesso:

• Status code: 201

Rotas dos tweets

Enviar um tweet

POST /tweets

Request:

Enviar no body da requisição

Params	Type	Description
username	string	Required, trim
tweet	string	Required, trim

Response:

Em caso de erro:

Status	Case
404	Usuário não encontrado

Em caso de sucesso:

• Status code: 201

Buscar todos os tweets

GET /tweets

Response:

Em caso de sucesso:

• Status code: 200
• Um array com todos os tweets

[
  {
    "username": "bobesponja",
    "avatar": "https://super.abril.com.br/wp-content/uploads/2020/09/04-09_gato_SITE.jpg?quality=70&strip=info",
    "tweet": "eu amo o hub"
  }
]

Buscar todos os tweets de um usuário

GET /tweets/{username}

Request:

Enviar no params da requisição

Params	Type	Description
username	string	Required, trim

Response:

Em caso de erro:

Status	Case
404	Usuário não encontrado

Em caso de sucesso:

• Status code: 200
• Um array com todos os tweets daquele usuário

[
  {
    "username": "bobesponja",
    "avatar": "https://super.abril.com.br/wp-content/uploads/2020/09/04-09_gato_SITE.jpg?quality=70&strip=info",
    "tweet": "eu amo o hub"
  }
]

Rodar com docker

Clone o projeto

  git clone https://github.com/ThVinicius/tweteroo-spring.git

Vá para o diretório do projeto

  cd tweteroo-spring

Faça o build do container

  docker build -t tweteroo/spring:1.0 .

Execute o container

  docker run -p 8080:8080 tweteroo/spring:1.0

Caso queira parar o container basta utilizar o comando Ctrl + C

Acknowledgements

• Awesome Badges