Skip to content

O QR Code Generator é uma API desenvolvida em Java com Spring Boot que permite gerar QR Codes a partir de textos enviados via requisição HTTP. O QR Code gerado é salvo automaticamente na AWS S3 e a URL pública da imagem é retornada como resposta da API.

Notifications You must be signed in to change notification settings

Robson-Carvalho/QRcode-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR Code Generetor 📜


📖 Descrição

O QR Code Generator é uma API desenvolvida em Java com Spring Boot que permite gerar QR Codes a partir de textos enviados via requisição HTTP. O QR Code gerado é salvo automaticamente na AWS S3 e a URL pública da imagem é retornada como resposta da API.

Esse projeto é útil para aplicações que desejam disponibilizar links, códigos ou mensagens em forma de QR Code de maneira automatizada e escalável, sem depender de bibliotecas frontend.

🛠️ Tecnologias Utilizadas

  • Java – Linguagem principal da aplicação
  • Spring Boot – Framework para desenvolvimento da API
  • ZXing – Biblioteca para geração de QR Codes
  • AWS S3 – Armazenamento em nuvem das imagens geradas
  • Docker – Conteinerização da aplicação

🚀 Como Executar

🔧 Pré-requisitos

  • Java 21 instalado
  • Docker (opcional)
  • Credenciais da AWS válidas

▶️ Execução com Docker

# 1. Build da imagem
docker build -t qrcode-generator .

# 2. Execute o container com as variáveis de ambiente
docker run --env-file .env -p 8080:8080 qrcode-generator

📁 Exemplo de .env

AWS_ACCESS_KEY=SUACHAVE
AWS_SECRET_KEY=SUA_CHAVE_SECRETA
AWS_S3_BUCKET=nome-do-bucket
AWS_S3_REGION=us-east-1

📫 Requisição para geração

POST /qrcode
Content-Type: application/json
Host: localhost:8080

{
  "text": "https://github.com/Robson-Carvalho"
}

✅ Resposta

{
  "url": "https://nome-do-bucket.s3.us-east-1.amazonaws.com/uuid.png"
}

📁 Estrutura do Projeto

  • controller: expõe a API REST
  • service: lógica para geração e upload do QR
  • dto: objetos de entrada e saída
  • ports: abstração de armazenamento
  • infrastructure: implementação da AWS S3

🤝 Contribuindo

  1. Faça um fork do projeto
  2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
  3. Commit suas alterações (git commit -m 'feat: nova funcionalidade')
  4. Dê push na sua branch (git push origin feature/nova-feature)
  5. Abra um Pull Request

🐛 Problemas?

Se você encontrar algum problema ou tiver sugestões de melhoria, sinta-se à vontade para abrir uma issue.

📜 Licença

Distribuído sob a licença MIT. Consulte o arquivo LICENSE para mais detalhes.

About

O QR Code Generator é uma API desenvolvida em Java com Spring Boot que permite gerar QR Codes a partir de textos enviados via requisição HTTP. O QR Code gerado é salvo automaticamente na AWS S3 e a URL pública da imagem é retornada como resposta da API.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published