API docs by Redocly

High Scores API (1.0.0)

Download OpenAPI specification:Download

Minae Lee: minae.lee@gmail.com License: MIT

API for managing high scores

HighScores

Endpoints for managing high scores

Get all high scores

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete all high scores

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Add a new high score record

Request Body schema: application/json
required
id
integer
name
string
score
integer

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Lou",
  • "score": 93477
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Lou",
  • "score": 93477
}

Get one high score

path Parameters
id
required
integer
Example: 1

ID of the high score

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Lou",
  • "score": 93477
}

Replace a high score record by ID

path Parameters
id
required
integer
Example: 1

ID of the high score

Request Body schema: application/json
required
name
string
score
integer

Responses

Request samples

Content type
application/json
{
  • "name": "Lou",
  • "score": 93477
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Lou",
  • "score": 93477
}

Update a high score by ID

path Parameters
id
required
integer
Example: 1

ID of the high score

Request Body schema: application/json
required
score
integer

Responses

Request samples

Content type
application/json
{
  • "score": 9999
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Lou",
  • "score": 93477
}

Delete a high score record by ID

path Parameters
id
required
integer
Example: 1

ID of the high score

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}