{"id":19031532,"url":"https://github.com/cami-la/url-shortener-preview","last_synced_at":"2025-07-24T03:07:01.345Z","repository":{"id":175904604,"uuid":"638480756","full_name":"cami-la/url-shortener-preview","owner":"cami-la","description":"Esta é uma API para encurtar URLs e redirecionar para a URL original.","archived":false,"fork":false,"pushed_at":"2023-06-26T22:10:20.000Z","size":100,"stargazers_count":324,"open_issues_count":0,"forks_count":40,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-20T01:05:21.210Z","etag":null,"topics":["google-guava","h2-database","java17","junit5","mockito","postgresql-database","railway-app","shortener-url","spring-boot","spring-boot-3"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cami-la.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-09T13:02:34.000Z","updated_at":"2025-05-19T23:29:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"42f7d2b6-990e-4089-8305-a0ded8ce0bc7","html_url":"https://github.com/cami-la/url-shortener-preview","commit_stats":null,"previous_names":["cami-la/url-shortener-preview"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cami-la/url-shortener-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cami-la%2Furl-shortener-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cami-la%2Furl-shortener-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cami-la%2Furl-shortener-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cami-la%2Furl-shortener-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cami-la","download_url":"https://codeload.github.com/cami-la/url-shortener-preview/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cami-la%2Furl-shortener-preview/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266786798,"owners_count":23983871,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["google-guava","h2-database","java17","junit5","mockito","postgresql-database","railway-app","shortener-url","spring-boot","spring-boot-3"],"created_at":"2024-11-08T21:24:01.944Z","updated_at":"2025-07-24T03:07:01.320Z","avatar_url":"https://github.com/cami-la.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eurl-shortener\u003c/h1\u003e\n\u003cp\u003eO URL Shortener é um projeto que oferece um serviço de encurtamento de URLs. Destaca-se pela funcionalidade de redirect eficiente, persistência de dados confiável, testes abrangentes (unidade e integração), hospedagem em nuvem pública e documentação.\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n     \u003ca alt=\"Java\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Java-v17-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Spring Boot\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Spring%20Boot-v3.0.6-brightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Gradle\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Gradle-v7.6-lightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"google Guava\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/guava-v30.1.1-red.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"H2\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/H2-v2.1.214-darkblue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"PostgreSQL\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/PostgreSQL-v42.5.6-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"JUnit5\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/JUnit5-v5.9.2-darkred.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Mockito\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Mockito-v4.8.1-darkgreen.svg\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## Configuração\n\nEssas instruções fornecerão aos usuários as etapas necessárias para clonar o repositório e iniciar a aplicação em\ndiferentes ambientes (Unix e Windows) com o perfil de desenvolvimento ativado.\n\n1. Clone o repositório: git clone https://github.com/cami-la/url-shortener.git\n2. Inicie a aplicação no ambiente Unix: `./gradlew bootrun --args='--spring.profiles.active=dev'`\n3. Inicie a aplicação no ambiente Windows: `gradle.bat bootrun --args='--spring.profiles.active=dev'`\n\n## Uso da API\n\n\u003e Request da requisição\n\n### Criar uma URL curta\n\nPOST /\n\n- Descrição: Cria uma URL curta a partir de uma URL original.\n- Parâmetros da solicitação:\n    - `originalUrl` (obrigatório): A URL original a ser encurtada.\n- Exemplo de solicitação:\n\nPOST /?originalUrl=https://www.example.com\n\n### Redirecionar para a URL original\n\nGET /{shortUrl}\n\n- Descrição: Redireciona para a URL original com base no código de URL encurtada.\n- Exemplo de solicitação:\n\nGET /abc123\n\n\u003e Response da requisição\n\n### Exemplos de Respostas\n\n- Resposta bem-sucedida para criação de URL curta (POST):\n\nHTTP/1.1 201 Created\nContent-Type: application/json\n\n{\n\"id\": \"12345\",\n\"originalUrl\": \"https://www.example.com\",\n\"shortUrl\": \"abc123\"\n}\n\n- Resposta bem-sucedida para redirecionamento (GET):\n\nHTTP/1.1 301 Moved Permanently\nLocation: https://www.example.com\n\n- Resposta mal-sucedida para redirecionamento (GET):\n\nHTTP/1.1 404 Not Found\nContent-Type: application/json\n\n{\n\"message\": \"URL Not Found\",\n\"timestamp\": \"2023-05-18T10:30:00\",\n\"status\": 404,\n\"error\": \"class dev.camila.url.shortener.exception.BusinessException\",\n\"details\": {\n\"Cause\": \"'abc123' not found\"\n}\n}\n\n## Documentação do Swagger\n\nA documentação da API pode ser encontrada no Swagger. Para visualizá-la,\nacesse: [Documentação do Swagger](http://localhost:8080/swagger-ui/index.html#/).\n\n## Hospedagem no Railway.app\n\nEste projeto está hospedado no Railway.app. Para acessar a aplicação,\nacesse: [URL da Aplicação](https://sua-url-de-hospedagem-aqui).\n\u003ch6\u003eNota: Este projeto não está mais hospedado no https://railway.app/ devido a questões financeiras. No\nentanto, a aplicação e o banco de dados estão prontos para serem hospedados no Railway.app. Se você estiver interessado\nem vê-los hospedados, por favor, me avise e farei a implantação rapidamente para você. (:\u003c/h6\u003e\n\n## Possíveis Melhorias\n\n- Utilizar Migrations com Flyway para gerenciar as alterações no banco de dados de forma controlada e versionada.\n- Trocar o Banco de Dados PostgreSQL pelo MongoDB, aproveitando as características e benefícios oferecidos pelo MongoDB.\n- Criar um Dockerfile e docker-compose para facilitar o processo de implantação e execução do aplicativo em um ambiente\n  de contêiner.\n- Configurar CI/CD no GitHub Actions ou no próprio Railway.app para automatizar o processo de construção, testes e\n  implantação do aplicativo.\n\n## Contribuição\n\nContribuições são bem-vindas! Se você encontrar algum problema ou tiver sugestões de melhoria, fique à vontade para\nabrir uma issue ou enviar um pull request.\n\n## Licença\n\nEste projeto está licenciado sob a licença MIT. Consulte o\narquivo \u003ca href=\"https://github.com/cami-la/url-shortener-preview/blob/3eb25645b0ca1a1ee8bd8b5de947c11f5a6d42ba/LICENSE.md\"\u003e(LICENSE)\u003c/a\u003e para obter.\n\n\u003chr\u003e\n\n\u003ch3\u003eAutor\u003c/h3\u003e\n\n\u003ca href=\"https://www.linkedin.com/in/cami-la/\"\u003e\n \u003cimg style=\"border-radius: 50%;\" src=\"https://avatars.githubusercontent.com/u/64323124?v=4\" width=\"100px;\" alt=\"\"/\u003e\n \u003cbr /\u003e\n \u003csub\u003e\u003cb\u003eCamila Cavalcante\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e \u003ca href=\"https://www.instagram.com/camimi_la/\" title=\"Instagram\"\u003e\u003c/a\u003e\n\nFeito com ❤️ por Cami-la 👋🏽 Entre em contato!\n\n[![Linkedin Badge](https://img.shields.io/badge/-Camila-blue?style=flat-square\u0026logo=Linkedin\u0026logoColor=white\u0026link=https://www.linkedin.com/in/cami-la/)](https://www.linkedin.com/in/cami-la/)\n[![Gmail Badge](https://img.shields.io/badge/-camiladsantoscavalcante@gmail.com-c14438?style=flat-square\u0026logo=Gmail\u0026logoColor=white\u0026link=mailto:camiladsantoscavalcante@gmail.com)](mailto:camiladsantoscavalcante@gmail.com)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcami-la%2Furl-shortener-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcami-la%2Furl-shortener-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcami-la%2Furl-shortener-preview/lists"}