API docs by Redocly

Typing API (0.0.1)

Download OpenAPI specification:

This is Typing API

other

いい名前が思いつかない(仮)

サーバーの状態を取得

Responses

user

ユーザー関係(仮)

ユーザー情報を取得

query Parameters
student_number
required
string

学生番号

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "student_number": "string",
  • "handle_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

score

スコア関係(仮)

スコアランキングを取得

query Parameters
sort_by
required
string
Enum: "keystrokes" "accuracy"

ソート対象のカラム

start
required
integer >= 1

ランキングの開始位置(x位 | x>0)

limit
required
integer >= 1

ランキングの取得件数

Responses

Response samples

Content type
application/json
{
  • "rankings": [
    ],
  • "total_count": 0
}

スコアを登録

Request Body schema: application/json
required
user_id
required
string <uuid>

ユーザーID

keystrokes
required
integer

キーストローク数

accuracy
required
number <float>

正確性(ミスタイプ数/ストローク数)

Responses

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "keystrokes": 0,
  • "accuracy": 0.1
}

ユーザーの現在の順位を取得

path Parameters
user-id
required
string <uuid>

ユーザーID

Responses

Response samples

Content type
application/json
{
  • "current_rank": 0,
  • "total_users": 0
}