URL Shortener

API para encurtar URLs desenvolvida com FastAPI e arquitetura assíncrona para alto desempenho, além de contar com caching. Códigos de URL criados utilizando base 62 com range de 7 dígitos, possibilitando 62⁷ combinações de caracteres, valor mais do que suficiente para a escalabilidade do serviço. UI da API disponível em /para teste intuitivo dos endpoints.

Tech Stack

• Framework Web: FastAPI
• Banco de Dados: PostgreSQL
• Cache: Redis
• Container: Docker Compose
• SQL Toolkit: SQLAlchemy
• Testes: Pytest
• Templating: Jinja

Instalação Local

1. Clone o repositório

   git clone https://github.com/ma-alves/url-shortener.git

2. Configure as variáveis de ambiente

   cp .env.example .env

   Edite o arquivo .env com as configurações necessárias.

3. Inicie os serviços com Docker Compose

   docker compose up --build

   Este comando irá:

   • Criar e iniciar o banco de dados
   • Iniciar o cache Redis
   • Executar as migrações do banco de dados
   • Iniciar a aplicação na porta 8000

4. Acesse a UI e a documentação interativa
   • Index: http://localhost:8000/
   • Swagger UI: http://localhost:8000/docs
   • ReDoc: http://localhost:8000/redoc

Parar os serviços

docker compose down

API Endpoints

Encurtar URL

• Método: POST
• Rota: /shorten
• Descrição: Cria uma URL encurtada a partir de uma URL longa
• Request Body:
  • url (json, obrigatório): A URL a ser encurtada (formato dict por enquanto)
• Resposta (201):

  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "long_url": "https://exemplo.com/pagina-muito-longa",
    "short_code": "abc1234",
    "created_at": "2026-01-29T10:30:00"
  }

• Comportamento: Se a URL já tiver sido encurtada anteriormente, retorna o código encurtado existente

Redirecionar para URL Original

• Método: GET
• Rota: /{short_code}
• Descrição: Redireciona para a URL original usando o código encurtado
• Parâmetros:
  • short_code (path, obrigatório): O código encurtado da URL
• Resposta (302): Redireciona para a URL original
• Resposta de Erro (404):

  {
    "detail": "URL não encontrada."
  }

• Cache: As URLs acessadas são armazenadas em cache para melhor desempenho