API docs by Redocly

ダンカグライク API Server 仕様 (0.0.4)

Download OpenAPI specification:Download

support

機能のサポート情報

APIサーバーの機能一覧API

有効なAPIサーバーの機能を返します

Responses

Response samples

Content type
application/json
{
  • "contents": true,
  • "accounts": true,
  • "ranking": true,
  • "options": {
    }
}

contents

コンテンツ情報

コンテンツ一覧API

コンテンツ一覧を全件取得して返却します
idの昇順。

Responses

Response samples

Content type
application/json
{
  • "contents": [
    ]
}

コンテンツ詳細API

コンテンツ詳細を取得して返却します

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "downloadUrl": "string",
  • "imageUrl": "string"
}

コンテンツのダウンロード済みAPI

コンテンツのダウンロードカウントを1増やします

Responses

コンテンツ評価の取得API

contentIdのコンテンツ評価を取得する

Responses

Response samples

Content type
application/json
{
  • "votes": [
    ]
}

コンテンツ評価の新規登録API

contentIdのコンテンツ評価を新規登録する

Request Body schema: application/json

vote

id
integer
contentId
integer

コンテンツのid番号

userId
string

ユーザー固有のid文字列

name
string

投稿者名

score
integer

評価の値 (1~5)

comment
string

評価一覧で表示されるコメント

like
integer

いいね数

date
string

UTC時間

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "contentId": 0,
  • "userId": "string",
  • "name": "string",
  • "score": 0,
  • "comment": "string",
  • "like": 0,
  • "date": "string"
}

コンテンツ評価の編集API

contentIdのコンテンツ評価を編集する

Request Body schema: application/json

vote

id
integer
contentId
integer

コンテンツのid番号

userId
string

ユーザー固有のid文字列

name
string

投稿者名

score
integer

評価の値 (1~5)

comment
string

評価一覧で表示されるコメント

like
integer

いいね数

date
string

UTC時間

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "contentId": 0,
  • "userId": "string",
  • "name": "string",
  • "score": 0,
  • "comment": "string",
  • "like": 0,
  • "date": "string"
}

likes

いいね情報

いいね情報取得API

ユーザーのいいね情報を取得します

Responses

Response samples

Content type
application/json
{
  • "likes": [
    ]
}

評価のいいねAPI

評価のいいね数を1増やします
評価のいいね対象はRequest bodyに設定されます

Request Body schema: application/json
voteId
integer

Responses

Request samples

Content type
application/json
{
  • "voteId": 0
}

accounts

アカウント情報

アカウント情報登録API

ユーザーのアカウント情報を新規登録します

Request Body schema: application/json
email
string <email>

メールアドレス（任意）

accountId
string

アカウントID文字列

password
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "accountId": "string",
  • "password": "string"
}

アカウント情報更新API

ユーザーのアカウント情報を更新します

Request Body schema: application/json
accountId
string

アカウントID文字列

password
string

アカウントのパスワード

token
string

JWTトークン

name
string

アカウント名

icon
integer

アイコン画像ID

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "password": "string",
  • "token": "string",
  • "name": "string",
  • "icon": 0
}

アカウントログインAPI

アカウントにログインします

Request Body schema: application/json
accountId
string

アカウントID文字列

password
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "account": {
    }
}

パスワードリセットリクエストAPI

ユーザーのメールアドレスにパスワードリセット用のリンクを送信します

Request Body schema: application/json
email
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

ranking

ランキング情報

ランキングを取得する

上位200件のランキングを取得する

query Parameters
chartHash
required
string

曲の識別用ハッシュ

difficulty
required
integer

難易度

Responses

Response samples

Content type
application/json
{
  • "ranking": [
    ]
}

ランキングの作成または更新

ランキングを登録、または既存データを更新する

Request Body schema: application/json
songTitle
required
string

曲名

difficulty
required
integer

難易度

chartHash
required
string

譜面の識別用ハッシュ

accountId
required
string

ユーザーID

accountToken
required
string

アカウントのトークン

score
required
integer

プレイ時のスコア

maxScore
required
integer

その曲の最大スコア（満点判定用）

Responses

Request samples

Content type
application/json
{
  • "songTitle": "string",
  • "difficulty": 0,
  • "chartHash": "string",
  • "accountId": "string",
  • "accountToken": "string",
  • "score": 0,
  • "maxScore": 0
}

Response samples

Content type
application/json
{
  • "message": "Ranking updated successfully.",
  • "error": null
}