Ghink/InfiniteMusic
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Save (I have to have class now :D)

Browse Source
This commit is contained in:
Bigsk 2022-03-04 13:15:21 +08:00
parent 41fe08f311
commit f33a54cf02
1 changed files with 81 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
document/front_design/README.md
View File

@ -164,3 +164,83 @@
## Back (Admin) ## Back (Admin)
### Access Page ### Access Page
#### The access page use the path "/admin/access"
#### Only Admin can request this interface
#### Get list of user:
#### WebApi Interface Detail:
##### Path: `/api/userlist`
##### Method: `POST`
##### Args:
###### `token` `string` `user(admin operator) token`
##### Response Format: `Json`
##### Json Args:
###### `code` `int` `response code`
###### `content` `list` `list of all users`
##### List of all users (content):
###### `uid` `int` `user id`
###### `nickname` `string` `user's nickname`
###### `name` `string` `user's real name (if realname auth passed)`
#### Request for change operate:
#### WebApi Interface Detail:
##### Path: `/api/admin/access`
##### Method: `POST`
##### Args:
###### `token` `string` `user(admin operator) token`
###### `uid` `int` `user's id to change access`
###### `operate` `string` `admin or user, destination`
##### Response Format: `Json`
##### Json Args:
###### `code` `int` `response code`
### Audit Page (Writing)
#### The audit page use the path "/admin/audit/song" for song audit
#### Only Admin can request this interface
#### Get list of songs that songed by users
#### WebApi Interface Detail:
##### Path: `/api/auditlist/song`
##### Method: `POST`
##### Args:
###### `token` `string` `user(admin operator) token`
##### Response Format: `Json`
##### Json Args:
###### `code` `int` `response code`
###### `content` `list` `list of all users`
##### List of songs that users songed (content):
###### `sid` `int` `id of this song(v.) event`
###### `uid` `int` `user id`
###### `nickname` `string` `user's nickname`
###### `name` `string` `user's real name (if realname auth passed)`
###### `platform` `int` `platform of the song`
###### `id` `int` `id of the song`
###### `name` `string` `name of song`
###### `artists` `list` `list of artists`
###### `album` `dict` `album of this song`
###### `url` `string` `the media url of this song (source platform or system cache)`
#### Request for audit operate:
#### WebApi Interface Detail:
##### Path: `/api/admin/audit`
##### Method: `POST`
##### Args:
###### `token` `string` `user(admin operator) token`
###### `sid` `int` `id of this song(v.) event`
###### `operate` `string` `pass, abort and ignore`
##### Response Format: `Json`
##### Json Args:
###### `code` `int` `response code`
### List Page (Writing)
#### The list manage page use the path "/admin/list"
#### Only Admin can request this interface
#### Requests the public interface to get the list of blacklist songs and whitelist songs
##### `/api/list`
#### Request for list operate:
#### WebApi Interface Detail:
##### Path: `/api/`
##### Method: `POST`
##### Args:
###### `token` `string` `user(admin operator) token`
###### `sid` `int` `id of this song(v.) event`
###### `operate` `string` `pass, abort and ignore`
##### Response Format: `Json`
##### Json Args:
###### `code` `int` `response code`