picinelli/projeto-shortly

This project is an API to create shortened URL

Projeto - Shortly

🚀 Concluído! 🚀

Construção de uma API destinada à encurtamento de URLs
Código JS»

Sumário

• Introdução
• Instalação
• Rotas
• Tecnologias Utilizadas
• Contato

Introdução

Vamos ser francos: passar uma URL gigante de um meme, vídeo ou qualquer outra coisa na internet para um(a) amigo(a) é uma situação embaraçosa.

Tudo piora quando a pessoa que recebe o link não tem como abri-lo diretamente e é obrigada a escrever o link caractere por caractere.

Para evitar este tipo de situação e de quebra conseguir monitorar os acessos a este link, surgiram os encurtadores de URL. Esse projeto, portanto, tem a finalidade de receber URLs complexas e retornar uma encurtada para melhor uso.

Instalação

git clone https://github.com/picinelli/projeto-shortly.git

npm install

npm start

Rotas

• POST /sign-up
  Esta não é uma rota autenticada.
  Deve receber um corpo (body) no formato:

  {
    name: "Fulano",
    email: "Fulano@Fulano.com.br",
    password: "Fulano",
    confirmPassword: "Fulano"
  }
  

• POST /sign-in
  Esta não é uma rota autenticada.
  Deve receber um corpo (body) no formato:

  {
    email: "Fulano@Fulano.com.br",
    password: "Fulano"
  }
  

• POST /urls/shorten
  Esta é uma rota autenticada.
  Deve receber um corpo (body) no formato:

  {
    "url": "http(s)://fulano.com.br"
  }
  

  Deve responder um corpo (body) no formato:

  {
  "shortUrl": "a8745bcf"
  }
  

• GET /urls/:id
  Esta não é uma rota autenticada.
  Deve responder um corpo (body) no formato:

  {
  "shortUrl": "a8745bcf"
  }
  

• GET /urls/open/:shortUrl
  Esta não é uma rota autenticada.
  Esta rota deve redirecionar o usuário para a URL original.

• DELETE /urls/:id
  Esta é uma rota autenticada.
  Esta rota deve excluir a URL encurtada, caso seja do usuário.

• GET /users/:id
  Esta é uma rota autenticada.
  Deve responder um corpo (body) no formato:

  {
    "id": id do usuário,
    "name": nome do usuário,
    "visitCount": soma da quantidade de visitas de todos os links do usuário,
    "shortenedUrls": [
      {
        "id": 1,
        "shortUrl": "...",
        "url": "...",
        "visitCount": soma da quantidade de visitas do link
      },
      {...}
    ]
  }
  

• GET /ranking
  Esta não é uma rota autenticada.
  Deve responder um corpo (body) no formato:

 [
  {
   "id": id do usuário,
   "name": nome do usuário,
   "linksCount": 5,
   "visitCount": 100000
  },
  {
   "id": id do usuário,
   "name": nome do usuário,
   "linksCount": 3,
   "visitCount": 85453
  },
  {...} //max of 10
 ]

Tecnologias

Contato