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.
JavaScriptHTMLCSSDockerfile1 Estrelas35 Commits
API QR Code Generator
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.
Funcionalidades
Geração de QR Codes a partir de texto ou URLs.
Opções de personalização avançadas (cores, margem, qualidade da imagem).
API RESTful de fácil integração.
Documentação interativa com Swagger.
Tecnologias Utilizadas
Node.js: Ambiente de execução JavaScript.
Express.js: Framework web para Node.js.
qrcode: Biblioteca para geração de QR Codes.
Swagger/OpenAPI: Para documentação e teste da API.
Docker: Para conteinerização da aplicação.
Configuração e Instalação
Para configurar e executar este projeto localmente, siga os passos abaixo:
Pré-requisitos
Certifique-se de ter as seguintes ferramentas instaladas em sua máquina:
Node.js (versão 14 ou superior)
npm (gerenciador de pacotes do Node.js)
Docker (opcional, para execução via contêiner)
Instalação
Clone o repositório:
git clone https://github.com/Cry199/api-qrcode-generator.git
cd api-qrcode-generator
Instale as dependências:
npm install
Variáveis de Ambiente
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.
Executando a Aplicação
Localmente
npm start
A API estará disponível em http://localhost:8080 (ou na porta que você configurou).
Com Docker
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).
Uso da API
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.
Documentação Swagger
Após iniciar a aplicação, acesse a documentação Swagger em: