Skip to content

Commit f33a54c

Browse files
author
Bigsk
committed
Save (I have to have class now :D)
1 parent 41fe08f commit f33a54c

File tree

1 file changed

+81
-1
lines changed

1 file changed

+81
-1
lines changed

document/front_design/README.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,84 @@
163163

164164
## Back (Admin)
165165

166-
### Access Page
166+
### Access Page
167+
#### The access page use the path "/admin/access"
168+
#### Only Admin can request this interface
169+
#### Get list of user:
170+
#### WebApi Interface Detail:
171+
##### Path: `/api/userlist`
172+
##### Method: `POST`
173+
##### Args:
174+
###### `token` `string` `user(admin operator) token`
175+
##### Response Format: `Json`
176+
##### Json Args:
177+
###### `code` `int` `response code`
178+
###### `content` `list` `list of all users`
179+
##### List of all users (content):
180+
###### `uid` `int` `user id`
181+
###### `nickname` `string` `user's nickname`
182+
###### `name` `string` `user's real name (if realname auth passed)`
183+
#### Request for change operate:
184+
#### WebApi Interface Detail:
185+
##### Path: `/api/admin/access`
186+
##### Method: `POST`
187+
##### Args:
188+
###### `token` `string` `user(admin operator) token`
189+
###### `uid` `int` `user's id to change access`
190+
###### `operate` `string` `admin or user, destination`
191+
##### Response Format: `Json`
192+
##### Json Args:
193+
###### `code` `int` `response code`
194+
195+
### Audit Page (Writing)
196+
#### The audit page use the path "/admin/audit/song" for song audit
197+
#### Only Admin can request this interface
198+
#### Get list of songs that songed by users
199+
#### WebApi Interface Detail:
200+
##### Path: `/api/auditlist/song`
201+
##### Method: `POST`
202+
##### Args:
203+
###### `token` `string` `user(admin operator) token`
204+
##### Response Format: `Json`
205+
##### Json Args:
206+
###### `code` `int` `response code`
207+
###### `content` `list` `list of all users`
208+
##### List of songs that users songed (content):
209+
###### `sid` `int` `id of this song(v.) event`
210+
###### `uid` `int` `user id`
211+
###### `nickname` `string` `user's nickname`
212+
###### `name` `string` `user's real name (if realname auth passed)`
213+
###### `platform` `int` `platform of the song`
214+
###### `id` `int` `id of the song`
215+
###### `name` `string` `name of song`
216+
###### `artists` `list` `list of artists`
217+
###### `album` `dict` `album of this song`
218+
###### `url` `string` `the media url of this song (source platform or system cache)`
219+
#### Request for audit operate:
220+
#### WebApi Interface Detail:
221+
##### Path: `/api/admin/audit`
222+
##### Method: `POST`
223+
##### Args:
224+
###### `token` `string` `user(admin operator) token`
225+
###### `sid` `int` `id of this song(v.) event`
226+
###### `operate` `string` `pass, abort and ignore`
227+
##### Response Format: `Json`
228+
##### Json Args:
229+
###### `code` `int` `response code`
230+
231+
### List Page (Writing)
232+
#### The list manage page use the path "/admin/list"
233+
#### Only Admin can request this interface
234+
#### Requests the public interface to get the list of blacklist songs and whitelist songs
235+
##### `/api/list`
236+
#### Request for list operate:
237+
#### WebApi Interface Detail:
238+
##### Path: `/api/`
239+
##### Method: `POST`
240+
##### Args:
241+
###### `token` `string` `user(admin operator) token`
242+
###### `sid` `int` `id of this song(v.) event`
243+
###### `operate` `string` `pass, abort and ignore`
244+
##### Response Format: `Json`
245+
##### Json Args:
246+
###### `code` `int` `response code`

0 commit comments

Comments
 (0)