Desafio Backend: Encurtador de URL

Resolução do desafio proposto pelo repositorio Backend Brasil, confira detalhes neste link.

🚀 Tecnologias utilizadas

• Golang 1.22.6
• Gin Gonic
• Docker
• MongoDB
• Mongo Driver

Instalação

🔍 Baixe o projeto e teste você.

1. Clone o repositório:

   git clone https://github.com/reisvitt/url-shortener-go.git

2. Navegue até a pasta da aplicação:

   cd url-shortener-go

3. Faça uma cópia do .env.example e insirá suas variáveis de ambiente.

4. Execute o comando docker compose up (Opcional)

   Certifique-se de ter o Docker instalado em sua máquina

     docker compose up -d

   Caso for utilizar um banco MongoDB já existente, insirá o DB_CONNECTION no arquivo .env

5. Inicie o servidor

     go run main.go

Uso

1. Encurtando uma URL

Envie uma requisição POST para o endpoint /shorten-url, incluindo um corpo no formato JSON com o seguinte campo:

• url: A URL que você deseja encurta

Exemplo de Requisição via cURL:

curl -X POST -H "Content-Type: application/json" -d '{"url":"https://example.com"}' http://localhost:8080/shorten-url

Alternativamente, você pode usar um cliente HTTP de sua preferência, como Postman, Insomnia, ou qualquer outro.

2. Recebendo a URL Encurtada

O servidor retornará uma URL encurtada no formato JSON. Você pode utilizar essa URL encurtada diretamente em seu navegador para redirecionar para a URL original.

Exemplo de Resposta:

{
  "shortUrl": "http://localhost:8080/abc123"
}

3. Usando a URL Encurtada

Copie a URL encurtada retornada e insira-a em seu navegador. Você será automaticamente redirecionado para a URL original.

Licença

Este projeto está licenciado sob os termos da licença MIT. Veja o arquivo LICENSE para mais detalhes.