Skip to content

Instantly share code, notes, and snippets.

@cristofersousa
Created September 7, 2021 18:36
Show Gist options
  • Save cristofersousa/8b12cf57ed90b2419a6ad91b7ad5d014 to your computer and use it in GitHub Desktop.
Save cristofersousa/8b12cf57ed90b2419a6ad91b7ad5d014 to your computer and use it in GitHub Desktop.
GamesAPI.md

Games API

Contexto:

Várias empresas, estão entrando em contato com um fornecedor de jogos para PC e Console. O fornecedor precisa enviar semanalmente um e-mail com para os lojistas notificando-os sobre o estoque e sobre as novidades, o problema disso é que acaba ocupando tempo de vários funcionários para notificar os lojistas e conferir o que foi vendido.

Com base nisso, surgiu a demanda de dispor um WebService da qual, as empresas parceiras possam consumir o WebService do fornecedor, com isso teriam algumas facilidades. O fornecedor sugeriu para o programador que fizesse um WebService com as seguintes diretrizes:

  1. Listar todos os jogos.

  2. Listar um jogo com base no SKU informado.

  3. Atualizar um jogo com base no SKU informado.

  4. Remover um jogo que não existe mais no estoque com base no SKU informado.

Documentação da API

/api/games

ROTA METHOD DESCRIPTION
/api/games GET listar todos os jogos
/api/game POST adicionar um novo jogo
/api/game/skuId GET visualizar um jogo a partir do ID
/api/game/skuId PUT atualizar um jogo a partir do ID
/api/game/skuId DELETE remover um jogo a partir do ID

/api/lojista

ROTA METHOD DESCRIPTION
/api/cliente GET listar todos os clientes
/api/cliente POST criar um novo cliente
/api/cliente/clienteId GET visualizar um cliente a partir do ID
/api/cliente/clienteId PUT atualizar um cliente a partir do ID
/api/cliente/clienteId DELETE remover um cliente a partir do ID

/api/pedido

ROTA METHOD DESCRIPTION
/api/pedido GET listar todos os pedidos
/api/pedido POST criar um novo pedido
/api/pedido/pedidoId GET visualizar um pedido a partir do ID
/api/pedido/pedidoId PUT atualizar um pedido a partir do ID
/api/pedido/pedidoId DELETE remover um pedido a partir do ID

Instruções para entrega

  • Versione com git, e hospede seu código em algum serviço de sua preferência: github ou gitlab.
  • Crie um README com instruções claras sobre como executar seu projeto.
  • Submeta o link do seu repositório para o classroom da atividade.

Sobre o projeto

A API Restful deve contemplar os módulos Cliente, GAME e Pedido, sendo que cada um devera conter endpoints CRUD.

Sobre CRUD:

  • Create: Criação de cliente, game e pedidos.
  • Read: Leitura de cliente, game e pedidos.
  • Update: Atualização de cliente, game e pedidos.
  • Delete: Remoção de cliente, game e pedidos.

DataBase

As tabelas deverão conter as seguintes informações:

  • Cliente
  • nome
  • email
  • telefone
  • data de nascimento
  • endereço
    • Rua
    • complemento
    • bairro
    • cidade
    • estado
    • cep
  • data de cadastro
  • Game
  • nome
  • preço
  • foto
  • ano
  • Pedido
  • código do cliente,
  • código(s) do game,
  • data da criação`;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment