Loading repository data…
Loading repository data…
Cry199 / repository
Uma API RESTful para gerar QR Codes de forma rápida e personalizável. Esta API permite que você crie QR Codes a partir de dados fornecidos, com opções de customização como nível de correção de erro, tipo de imagem, qualidade, margem e cores.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Uma API RESTful para gerar QR Codes de forma rápida e personalizável. Esta API permite que você crie QR Codes a partir de dados fornecidos, com opções de customização como nível de correção de erro, tipo de imagem, qualidade, margem e cores.
Para configurar e executar este projeto localmente, siga os passos abaixo:
Certifique-se de ter as seguintes ferramentas instaladas em sua máquina:
Clone o repositório:
git clone https://github.com/Cry199/api-qrcode-generator.git
cd api-qrcode-generator
Instale as dependências:
npm install
Crie um arquivo .env na raiz do projeto com as seguintes variáveis:
PORT=8080
PORT: A porta na qual a API será executada. O valor padrão é 8080.npm start
A API estará disponível em http://localhost:8080 (ou na porta que você configurou).
Construa a imagem Docker:
docker build -t api-qrcode-generator .
Execute o contêiner Docker:
docker run -p 8080:8080 api-qrcode-generator
A API estará disponível em http://localhost:8080 (mapeada para a porta 8080 do contêiner).
A API expõe um endpoint para a geração de QR Codes. A documentação completa e interativa da API está disponível via Swagger.
Após iniciar a aplicação, acesse a documentação Swagger em:
http://localhost:8080/api-docs
/api/qrcodePOSTapplication/json{
"data": "https://www.example.com",
"options": {
"errorCorrectionLevel": "H",
"type": "image/png",
"quality": 0.92,
"margin": 1,
"color": {
"dark": "#000000",
"light": "#FFFFFF"
}
}
}
data (obrigatório, string): Os dados a serem codificados no QR Code (URL, texto, etc.).options (opcional, objeto): Opções de customização para o QR Code. As propriedades incluem:
errorCorrectionLevel (string, padrão: 'H'): Nível de correção de erro. Valores possíveis: 'L', 'M', 'Q', 'H'.type (string, padrão: 'image/png'): Tipo de imagem de saída. Valores possíveis: 'image/png', 'image/jpeg', 'image/webp'.quality (número, padrão: 0.92): Qualidade da imagem (para JPEG e WebP). Valor entre 0 e 1.margin (número, padrão: 1): Margem em torno do QR Code.color (objeto): Cores do QR Code.
dark (string, padrão: '#000000'): Cor dos módulos escuros (formato hexadecimal).light (string, padrão: '#FFFFFF'): Cor dos módulos claros (formato hexadecimal).{
"message": "QR Code gerado com sucesso!",
"qrCodeUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
qrCodeUrl: Uma Data URL contendo a imagem do QR Code gerado. Você pode usar esta URL diretamente em tags <img> em HTML ou para download.Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.
Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.