API docs by Redocly

prsk Music API (0.1.0)

Download OpenAPI specification:

  • Features
    • アーティストマスタ管理 - Management artist master

artists

アーティストマスタのデータを管理するAPI - Management data of artist master API

  • Features
    • アーティスト情報の登録 - Register artist information
    • アーティスト一覧取得 - Get artists list
    • アーティスト情報の更新 - Update artist information
    • アーティスト情報の削除 - Delete artist information

アーティスト一覧取得 - Get artists list

アーティスト一覧が取得できます - You can get artists list

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

ページ番号 - Page number

limit
integer [ 1 .. 1000 ]
Default: 20
Example: limit=20

1ページあたりのアイテム数 - Number of items per page

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

アーティスト情報の登録 - Register artist information

アーティスト情報を登録できます - You can register artist information

Conflict Conditions

以下の条件に該当する場合、409 Conflictを返します

  • 同じartistNameが既に存在するとき
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

アーティスト情報 - Artist information

artistName
required
string [ 1 .. 50 ] characters

アーティスト名 - Artist Name

unitName
string or null [ 1 .. 25 ] characters

ユニット名 - Unit Name

content
string or null [ 1 .. 20 ] characters

コンテンツ名 - Content Name

Responses

Request samples

Content type
application/json
{
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ",
  • "auditInfo": {
    }
}

アーティスト情報の更新 - Update artist information

アーティスト情報を更新できます - You can update artist information

Not Found Conditions

指定したIDのユーザーが存在しない場合、404 Not Foundを返します

Conflict Conditions

他のアーティストと同じartistNameに更新しようとしたとき409を返します

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

アーティストID - Artist ID

Request Body schema: application/json
required

アーティスト情報 - Artist information

non-empty
artistName
string [ 1 .. 50 ] characters

アーティスト名 - Artist Name

unitName
string or null [ 1 .. 25 ] characters

ユニット名 - Unit Name

content
string or null [ 1 .. 20 ] characters

コンテンツ名 - Content Name

Responses

Request samples

Content type
application/json
{
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ",
  • "auditInfo": {
    }
}

アーティスト情報の削除 - Delete artist information

アーティスト情報を削除できます - You can delete artist information

Not Found Conditions

指定したIDのユーザーが存在しない場合、404 Not Foundを返します

Implementation Note

論理削除を使用します

物理的なデータは削除されません

楽曲データは削除されません

楽曲から参照されているアーティストは不明なアーティストとして扱われるようになります

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

アーティストID - Artist ID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "Bad Request",
  • "message": "Invalid request parameters.",
  • "details": [
    ]
}

prsk-music

プロセカ楽曲マスタのデータを管理するAPI - Management data of prsk music master API

  • Features
    • プロセカ楽曲情報の登録 - Register prsk music information
    • プロセカ楽曲一覧取得 - Get prsk music list
    • プロセカ楽曲情報の更新 - Update prsk music information
    • プロセカ楽曲情報の削除 - Delete prsk music information

プロセカ楽曲リストの取得 - Get prsk music list

プロセカ楽曲一覧が取得できます - You can get prsk music list

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

ページ番号 - Page number

limit
integer [ 1 .. 1000 ]
Default: 20
Example: limit=20

1ページあたりのアイテム数 - Number of items per page

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

プロセカ楽曲の登録 - Register prsk music information

プロセカ楽曲情報を登録します - Register prsk music information

Conflict Conditions

以下の条件に該当する場合、409 Conflictを返します

  • 同じタイトルの楽曲が既に存在していて、かつ楽曲タイプも同じとき
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

プロセカ楽曲情報 - Prsk music information

title
required
string

楽曲タイトル - Music title

artistId
required
integer

アーティストID - Artist ID

  • GET /artistsで取得できるアーティストIDを指定してください - Please specify the artist ID that can be obtained with GET /artists
musicType
required
integer (MusicType)

楽曲の種類:

  • 0 : オリジナル（オリジナル楽曲）
  • 1 : 3DMV (プロセカ3DMV楽曲)
  • 2 : 2DMV (プロセカ2DMV楽曲)
specially
boolean or null

プロセカ書き下ろし楽曲かどうか - Whether it is a prsk specially commissioned music

lyricsName
string or null

作詞者名 - Lyricist name

musicName
string or null

作曲者名 - Composer name

featuring
string or null

ゲストメンバー名 - Featuring member name

youtubeLink
required
string

YouTubeリンク - YouTube link

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 1,
  • "title": "SToRY",
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ",
  • "musicType": 0,
  • "specially": true,
  • "lyricsName": "DECO*27",
  • "musicName": "DECO*27",
  • "featuring": "初音ミク",
  • "youtubeLink": "https://www.youtube.com/watch?v=9fnQklaziX4&list=RD9fnQklaziX4&start_radio=1",
  • "auditInfo": {
    }
}

プロセカ楽曲情報の更新 - Update prsk music information

プロセカ楽曲情報を更新できます - You can update prsk music information

Not Found Conditions

指定された楽曲IDが存在しない場合、404 Not Foundを返します

Conflict Conditions

以下の条件に該当する場合、409 Conflictを返します

  • 同じタイトルの楽曲が既に存在していて、かつ楽曲タイプも同じとき
Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

楽曲ID - Music ID

Request Body schema: application/json
required

プロセカ楽曲情報 - Prsk music information

title
string

楽曲タイトル - Music title

artistId
integer

アーティストID - Artist ID

  • GET /artistsで取得できるアーティストIDを指定してください - Please specify the artist ID that can be obtained with GET /artists
musicType
integer (MusicType)

楽曲の種類:

  • 0 : オリジナル（オリジナル楽曲）
  • 1 : 3DMV (プロセカ3DMV楽曲)
  • 2 : 2DMV (プロセカ2DMV楽曲)
specially
boolean or null

プロセカ書き下ろし楽曲かどうか - Whether it is a prsk specially commissioned music

lyricsName
string or null

作詞者名 - Lyricist name

musicName
string or null

作曲者名 - Composer name

featuring
string or null

ゲストメンバー名 - Featuring member name

youtubeLink
string

YouTubeリンク - YouTube link

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": 1,
  • "title": "SToRY",
  • "artistName": "Leo/need",
  • "unitName": "Leo/need",
  • "content": "プロセカ",
  • "musicType": 0,
  • "specially": true,
  • "lyricsName": "DECO*27",
  • "musicName": "DECO*27",
  • "featuring": "初音ミク",
  • "youtubeLink": "https://www.youtube.com/watch?v=9fnQklaziX4&list=RD9fnQklaziX4&start_radio=1",
  • "auditInfo": {
    }
}

プロセカ楽曲情報の削除 - Delete prsk music information

プロセカ楽曲情報を削除できます - You can delete prsk music information

Not Found Conditions

指定したIDの楽曲情報が存在しない場合、404 Not Foundを返します

Implementation Notes

論理削除を使用します

物理的なデータは削除されません

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

楽曲ID - Music ID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "Bad Request",
  • "message": "Invalid request parameters.",
  • "details": [
    ]
}

users

ユーザーマスタのデータを管理するAPI - Management data of user master API

  • Features
    • ユーザー情報の登録 - Register user information
    • ユーザー一覧取得 - Get users list
    • ユーザー情報の更新 - Update user information
    • ユーザー情報の削除 - Delete user information

ユーザー一覧取得 - Get users list

ユーザー一覧が取得できます - You can get users list

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

ページ番号 - Page number

limit
integer [ 1 .. 1000 ]
Default: 20
Example: limit=20

1ページあたりのアイテム数 - Number of items per page

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "meta": {
    }
}

ユーザー情報の登録 - Register user information

ユーザー情報を登録できます - You can register user information

Conflict Conditions

以下の条件に該当する場合、409 Conflictを返します

  • 同じuserNameが既に存在するとき

Note

1つのユーザー名につき1レコードのみ登録可能です。

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

ユーザー情報 - User information

userName
required
string

ユーザ名 - User Name

password
required
string

パスワード - Password

Responses

Request samples

Content type
application/json
{
  • "userName": "天馬 咲希",
  • "password": "p@ssw0rd"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "userName": "天馬 咲希",
  • "auditInfo": {
    }
}

ユーザー情報の更新 - Update user information

ユーザー情報を更新できます - You can update user information

Not Found Conditions

指定したIDのユーザーが存在しない場合、404 Not Foundを返します

Authentication error

ユーザーに紐づくパスワードが間違っている場合、401 Unauthorizedを返します

Conflict Conditions

他のユーザーと同じuserNameに更新しようとしたとき409を返します

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

ユーザーID - User ID

Request Body schema: application/json
required

ユーザー情報 - User information

userName
required
string

ユーザ名 - User Name

password
required
string

パスワード - Password

Responses

Request samples

Content type
application/json
{
  • "userName": "天馬 咲希",
  • "password": "p@ssw0rd"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "userName": "天馬 咲希",
  • "auditInfo": {
    }
}

ユーザー情報の削除 - Delete user information

ユーザー情報を削除できます - Delete user information

Not Found Conditions

指定したIDのユーザーが存在しない場合、404 Not Foundを返します

Implementation Note

論理削除を使用します

物理的なデータは削除されません

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer >= 1
Example: 1

ユーザーID - User ID

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "Bad Request",
  • "message": "Invalid request parameters.",
  • "details": [
    ]
}