https://github.com/sgerodes/bowling-game-calculator

https://github.com/sgerodes/bowling-game-calculator

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/sgerodes/bowling-game-calculator
• Owner: sgerodes
• Created: 2021-04-12T09:53:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T12:10:00.000Z (about 5 years ago)
• Last Synced: 2024-05-29T22:25:22.402Z (about 2 years ago)
• Language: Java
• Size: 114 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Requirements

- java 8

- gradle

# API

This project run as per default on localhost:8080

## calculate

    POST /api/calculate

This endpoint expects a json object via a POST request. The json should represent a valid bowling game. 

If an invalid json or game representation is sent a http 400 response is sent back with a description of the error.

### Body structure

The endpoint expects an Object with a field "frames", the value if the field is a list of list of integers. 

The outer list represents the whole game and should have 10 elements.

The inner lists represents individual frames and should have 1, 2 integer values in them. 

3 values are possible for the 10-th frame.

The integers represent pins impacted by a single roll.

Json example:

    {

       "frames" : [[1,2], [3,4], [3,4], [3,4], [3,4], [3,4], [3,4], [3,4], [3,4], [3,7,6]]  

    }

### response

If a valid request is sent the response would have a single field "overallPoints" with the total points for the game.

Example:

    {

        "overallPoints": 75

    }

If an invalid request is sent an error message would be displayed.

## Get all previously calculated games

    GET /api/history

Json response example:

    [

        {

            "id": 1,

            "initialInput": "[[7, 1], [3, 4], [3, 4], [3, 4], [6, 4], [3, 4], [5, 4], [3, 2], [3, 1], [9, 1, 6]]",

            "overallPoints": 83

        },

        {

            "id": 2,

            "initialInput": "[[1, 2], [3, 4], [3, 4], [3, 4], [3, 4], [3, 4], [3, 4], [3, 4], [3, 4], [3, 7, 6]]",

            "overallPoints": 75

        }

    ]

# Swagger API Documentation

Is accessible at 

    /swagger-ui.html