ThVinicius / Tweteroo-Orientado-a-Objetos-back-end

Projeto 25 Tweterro POO

Built With

Sumário

• Descrição
• Documentação da API
  • Rotas de autenticação
  • Rotas do tweets
    • Adicionar um tweet
    • Pegar os tweets do usuário
    • Pegar todos os tweets
  • Rodar localmente

Descrição

Tweterro POO é um projeto refatorado em orientado a objetos com classes.

Código original: Click to Download

Documentação da API

Rota de cadastro e login

POST /sign-up

Requisição (body):

Params	Type	Description
username	string	Required
avatar	string	Required

Respostas:

Casos de erro:

Status code	Cause
400	Requisição no formato incorreto

Em caso de sucesso: (status code 200) e uma string:

"OK deu tudo certo"

Rota do tweets

Adicionar um tweet

POST /tweets

Requisição (body):

Params	Type	Description
tweet	string	Required
username	string	Required

Respostas:

Casos de erro:

Status code	Cause
400	Requisição no formato incorreto
404	Usuário não encontrado

Em caso de sucesso: (status code 201) e uma string:

"OK, seu tweet foi criados"

Pegar os tweets do usuário

GET /tweets/:username

Requisição (params):

Params	Type	Description
username	string	Required

Respostas:

Em caso de sucesso: (status code 200) e um array de todos os tweets daquele usuário:

[
  { "tweet": "Oi", "username": "Teste", "avatar": "https://..." },
  { "tweet": "Olá", "username": "Teste", "avatar": "https://..." },
  { "tweet": "Saudações", "username": "Teste", "avatar": "https://..." }
]

Pegar todos os tweets

É necessário passar query params nessa rota

GET /tweets

Requisição (query):

Params	Type	Description
page	number	Required,greater than 1

Respostas:

Em caso de sucesso: (status code 200) e um array de todos os tweets:

[
  { "tweet": "Oi", "username": "Teste", "avatar": "https://..." },
  { "tweet": "Oi", "username": "Ronaldinho", "avatar": "https://..." },
  { "tweet": "Olá", "username": "Teste", "avatar": "https://..." },
  { "tweet": "Saudações", "username": "Teste", "avatar": "https://..." }
]

Rodar localmente

Clone o projeto

  git clone https://github.com/ThVinicius/Tweteroo-Orientado-a-Objetos-back-end.git

Vá para o diretório do projeto

  cd Tweteroo-Orientado-a-Objetos-back-end

Instale as dependências

  npm install

Inicie o servidor

  npm run dev

Acknowledgements

• Awesome Badges