Encurtador de Links

Criado por Augusto Preis Tomasi

Objetivo e motivação

Este encurtador de links foi criado como parte da disciplina de Backend, da 4ª fase do curso de Engenharia de Software, orientado pelo professor Ramon Venson

Rodando o projeto

• Instalar o Docker
• Criar um arquivo chamado .env na pasta raiz do projeto, contendo as seguintes informações (alterar conforme necessário):

PORT=8080

API_URL=https://api.encurtador.dev/encurtamentos

IS_DOCKER=FALSE
DB_IMAGE_NAME=postgres-db

DB_USER=postgres
DB_HOST=localhost
DB_NAME=encurtador
DB_PASS=admin
DB_PORT=5432

• Rodar o seguinte arquivo na pasta raiz do projeto: docker-compose up

Endpoints

Descrição: Busca a url original com base na url encurtada informada pelo usuário
Método: GET
Url: /link/buscar
Params: urlEncurtada (string)

Exemplo: (js)

const result = await fetch('http://localhost:8080/link/buscar?urlEncurtada=acesse.one/JJufE');

console.log(await result.json()); // {urlOriginal: 'string'}

Descrição: Encurta a url informada pelo usuário
Método: POST
Url: /link/encurtar
Body: {
  link (string)
}

Exemplo: (js)

const result = await fetch('http://localhost:8080/link/encurtar', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ link: 'http://google.com' }),
});

console.log(await result.json()); // {urlEncurtada: 'string'};

Descrição: Informações do projeto
Método: GET
Url: /sobre

Exemplo: (js)

const result = await fetch('http://localhost:8080/sobre');

console.log(await result.json()); // {estudante: 'string', projeto: 'string'}