/spring-encurtador-url

Um simples encurtador de url feito em Java para por em prática meus conhecimentos sobre Spring obtidos no treinamento Gama Academy

Primary LanguageJavaMIT LicenseMIT

Spring-Encurtador-Url

Um simples encurtador de url feito em Java para por em prática meus conhecimentos sobre Spring obtidos no treinamento Gama Academy.

Uso da API

Registro de Links

Para realizar o cadastro de um novo link na api do encurtador é muito simples. Basta enviar o link para /api/v1/links no formato de Json. Seguindo o seguinte modelo:

{
  "link": "https://github.com"
}

Dessa forma o link será cadastro em nossos servidores e será retornada o link encurtado juntamente com o contador de acessos (que por padrão inicia-se em 0):

{
  "id": 1,
  "link": "https://github.com",
  "linkEncurtado": "$PREFIX/seu_hash",
  "acessos": 0
}

Nota: Vale destacar que se um link enviado pelo consumidor da API já estiver cadastrado, a mesma faz o retorno do registro já salvo poupando de alguns possíveis problemas.

Obtenção de Links

Os links já cadastrados podem ser obtidos através de seus respectivos IDs, link ou linkEncurtado.

Via ID
  • /api/v1/links/{id} GET
Via Links
  • /api/v1/links/filtro?link={link_desejado} GET

Remoção

  • /api/v1/links/{id} DELETE