Qr Code Api System

Apenas o esqueleto do projeto está pronto, é importante uma refatoração para otimização e organização do código, e a API não foi lançada no servidor ainda, nem o banco de dados está online

Ajustes e melhorias

O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:

• Conexão com banco de dados.
• Separação em classes específicas, para aplicar eventuais regras de negócios.
• Endpoints de Qrcode e de usuários prontos.
• Lançar no servidor, juntamente com banco de dados online.
• Refatoração e etapa de testes.
• Detalhar utilização dos endpoints.

💻 Sobre o projeto

Em resumo, o projeto consiste em uma api construída em PHP (Sem frameworks) e MySQL, onde é possível fazer um CRUD básico tanto de usuários como de QR Codes gerados (Mas na frente falarei mais sobre cada um e seus respectivos endpoints).

Caso você queira replicar esse projeto, esses são alguns pré-requisitos, baseados em como a Api foi construída (Pode funcionar de outras formas)

• XAMMP v3.3.0
• PHP v8.1.6
• MySQL v8.0.27

🚀 Replicando

Para replicar o projeto, siga estas etapas:

1. Clone este repositório para sua máquina local.
2. Execute o arquivo Databse.sql, para criar o o banco e tabelas necessárias.
3. Inicie o servidor Apache
4. Acesse o index.php e suas devidas rotas

☕ Endpoints

Abaixo estão descritos os endpoints:

Endpoints Usuários

• login
• setuser
• getusers
• updateuser
• deleteuser

Endpoints QR Codes

• getqrcodes
• setqrcode
• updateqrcode
• deleteqrcode
• redirect

Cada um dos endpoints serão detalhados posteriormente, mas caso haja alguma dúvida não hesite em me perguntar aqui no Github ou pelo Linkdin

📫 Contribuindo para <nome_do_projeto>

Para contribuir, siga estas etapas:

1. Bifurque este repositório.
2. Crie um branch: git checkout -b <nome_branch>.
3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

😄 Seja um dos contribuidores

Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.

⬆ Voltar ao topo