Serviço de encurtamento de URL's disponibilizado via API REST. Trata-se de uma POC.

Disponível em: http://uolurlshortener-env.eba-qxnpezmw.us-east-2.elasticbeanstalk.com/

Utilize os endpoints do postman para consumir o serviço.

mvn sprint-boot:run

mvn clean test

Para build e gerenciamento de dependências da aplicação

Para a criação da aplicação API RESTful

Para persistência em banco de dados relacional. O banco escolhido foi o MySQL por motivos práticos. Por fazer parte da especificação JPA, podemos migrar para outra solução de RDBS. Observação: para fins de testes, foi utilizado o banco relacional em memória H2. As conexões com o banco são gerenciadas via pool de conexões com hikariCP.

Segurança da aplicação. Autenticação Oauth com bearer token. Obs: como se trata de uma POC, o servidor de autenticação é em memória, contendo apenas 1 usuário, mas é fácilmente possível extender para soluções prontas para produção como Keycloak.

Solução de caching para entregar rapidamente as URLs para os clientes. Não há necessidade de recalcular as URLs todas as vezes, pois as informações não mudam, uma vez que é feito o cálculo do hash/alias, ele não mudará, pois o hash é único por URL.

Obs: como se trata de uma POC, o cache é em disco na instância da aplicação, mas como segue a especificação JCache, pode ser extendido para uma solução de cache distribuído como Redis.

biblioteca para geração de hash ids que atende os requisitos de um encurtador de URLs:

• Hashes curtos
• Hashes únicos
• Rápido de ser calculado
• Fácil de fazer encode/decode
• Evita palavras ofensivas.

https://hashids.org/java/

Solução de logging, flexibiliza a customização de appenders. Obs: como se trata de uma POC, foram configurados appenders do console. Por seguir a especificação SL4FJ, pode ser fácilmente extendido para utilizar soluções de logs centralizados como ElasticSearch e Kibana.

documentação da API RESTful

Para testar os endpoints da API RESTful

Testes unitários e de Integração

O código da aplicação está dividido em camadas, cada uma com suas responsabilidades bem definidas, seguindo os principios SOLID e injeção de dependências.

• application -> entry point (main) da aplicação

• config -> configurações da aplicação (cache, segurança, etc)

• controller -> mapeia os endpoints da API RESTful, recebe as requisições e devolve as respostas de sucesso/erro.

• exception -> exceções de negócio da aplicação (e.g. URL não encontrada, falha ao encurtar URL etc).

• generator -> classes utilitárias para geração de hash/alias de URL curta.

• logger -> configurações de log da aplicação

• service -> regras de negócio da aplicação. encurtar URL, validar URL, verificar se URL existe, etc.

• repository -> padrão Repository para persistência dos dados em banco relacional utilizando JPA e Hibernate.

• model.dto -> DTO (Data Transfer Objects) objetos imutáveis e serializaveis para trafegar na rede. Serve como payload de requisição e resposta da API, de maneira que fique desacoplada das entidades do domínio da aplicação.

• model.entity -> Entidades de domínio da aplicação (e.g. url curta, dados estatisticos) que são persistidas e a partir das quais são aplicadas as regras de negócio na camada de serviço.

• ShortUrl -> Armazena a URL curta, mapeando o id com a URL original

• ShortUrlDomain -> Domínio ao qual a URL curta pertence. Util para caso a aplicação esteja em domínios diferentes.

Expor o IP da máquina diretamente é arriscado, por questões de segurança e porque a mesma pode estar em rede privada, ou por trás de uma API gateway ou de um Load balancer. Ou seja, pode não ser acessível diretamente.

Não é uma boa ideia persistir a URL curta completa para cada registro da entidade ShortUrl pois em caso de mudança de domínio, dará mais trabalho atualizar milhares de colunas no banco de dados. Desta forma, basta atualizar 1 registro de domínio para que todas as URL curtas associadas sejam refletidas sem impacto na aplicação.

• ShortUrlStatistics -> dados estatísticos da URL encurtada como quantas vezes essa URL foi acessada?