Fase 2: Desenvolvimento da API

[LaurenceZanotti]

Definições gerais da API

Formato: JSON

OBS: Para desenvolver uma API o ideal é usar Django REST Framework para projetos de médio e grande porte. Neste foi escolhido Django puro devido a simplicidade.

Recurso Jogo

💎 são essenciais ❌ não necessários no MVP

• [x] GET api/jogos -> Lista de jogos completa 💎
• [x] GET api/jogos/:id -> Jogo único 💎
• [ ] POST api/jogos -> Criar objeto no servidor ❌
• [ ] GET api/jogos/:id/new -> Form para adicionar jogo ❌
• [ ] GET api/jogos/:id/edit -> Form para editar jogo ❌
• [ ] PATCH api/jogos/:id -> Atualizar objeto no servidor ❌
• [ ] DELETE api/jogos/:id -> Deletar objeto no servidor ❌

Recurso Compra

Ação: Usuário clica em Comprar

• [x] POST api/jogo/:id/comprar -> Criar registro em Compras 💎

OBS: Outras rotas REST não são necessárias aqui pois esse recurso será visualizado/gerenciado pelo painel de administração na rota /admin

QR Code

• [x] POST api/desconto -> Recebe string de QR Code e retorna se é válido ou não 💎

Referências para implementação

https://www.learnhowtoprogram.com/c-and-net/basic-web-applications/introduction-to-restful-routing https://gearheart.io/articles/restful-api-design-best-practices/

[LaurenceZanotti]

Gerando QR Code de desconto

• QR Code gerado em: https://br.qr-code-generator.com/
• Site do hash: https://www.md5hashgenerator.com/

Exemplo

• Hash MD5 da string: 047739d00bf17cd2f863ecaa7cc57c9a
• String MD5 puro: desconto-smart-games
• String completa: desconto-smart-games-047739d00bf17cd2f863ecaa7cc57c9a
• Arquivo base: qr-desconto.png

Fluxo

1. Ler QR Code e obter string
2. Enviar string para api/desconto
3. Validar string (QR Code)

[LaurenceZanotti]

Rotas REST fundamentais finalizadas

Próximo: Alterar Compras para mostrar se desconto foi usado

[LaurenceZanotti]

Requisitos mínimos da API finalizados. Pronto para merge