Giter Site home page Giter Site logo

cardgame's Introduction

API DE CARD GAME

Ao subir a aplicação, será feito uma busca na omdbapi pra popular o banco com alguns filmes para teste. Aguarde a mensagem de "jogo liberado" nos logs da aplicação para começar a jogar.

como usar:
Dois usuários foram criados inicialmente para poder rodar todo o fluxo da api

usuário 1: username: bruno, senha: 123

usuário 2: username: bruna, senha 123

essa api usa o método basic de autenticação
para testar via postman, selecione a aba authorization, selecione o type basic auth e será apresentados os inputs de user e password.
caso queria testar via curl, será necessário gerar o token do basic pelo site blitter.se e enviar o token pelo header, por exemplo
--header 'Authorization: Basic c2lsYXM6MTIz'
TODOS OS ENDPOINT UTILIZADOS PRECISAM DE ATUTENTICAÇÃO
Ao iniciar uma partida, o usuario logado será vinculado à partida iniciada. Ao jogar uma partida, será verificado se o usuário logado é o usuário que iniciou a partida. Caso contrário retornará erro de não autorização.

Começando uma partida

Para iniciar uma partida
POST /api/v1/round/start
Ao iniciar a partida, o id da rodada (round) e os dois primeiros filmes serão informados

Jogando uma rodada

para jogar uma rodada
POST /api/v1/round/play?roundId={X}&movieId={Y}
deverá ser informado o id da rodada e o id do filme escolhido

o jogador tem 3 chances de acertar qual filme que possui maior pontuação

caso acerte qual filme tem maior pontuação, receberá um mensagem de acerto e somará mais um ponto na partida

Caso não exista novos filmes a serem jogados, a partida se encerrará automaticamente

Encerrando uma partida

Você pode encerrar uma partida a qualquer momento pelo endpoint
POST /api/v1/round/finish?roundId={x}
Utilizando o id da partida que deseja encerrar

Visualizando RANKING

Para visualizar o ranking de partidas com mais pontos
GET /api/v1/round/ranking

DOCUMENTAÇÃO

Toda a documentação desta api está disponivel no link do swagger
{url}/swagger-ui/

cardgame's People

Contributors

brzangado avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.