girineko/YesPlayMusic
1
0
Fork 0
mirror of https://github.com/GiriNeko/YesPlayMusic.git synced 2025-12-17 05:38:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update api comments with jsdoc. (#52)

Browse source
This commit is contained in:
Hawtim Zhang 2020-10-25 14:15:02 +08:00 • committed by GitHub
parent e9b6a81bef
commit 4e482941ed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 189 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/api/user.js
View file

@ -1,5 +1,11 @@
import request from "@/utils/request";
/**
* 获取用户详情
* 说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户详情
* - uid : 用户 id
* @param {number} uid
*/
export function userDetail(uid) {
return request({
url: "/user/detail",
@ -10,9 +16,18 @@ export function userDetail(uid) {
});
}
/**
* 获取用户歌单
* 说明 : 登录后调用此接口 , 传入用户 id, 可以获取用户歌单
* - uid : 用户 id
* - limit : 返回数量 , 默认为 30
* - offset : 偏移数量，用于分页 , 如 :( 页数 -1)*30, 其中 30 为 limit 的值 , 默认为 0
* @param {Object} params
* @param {number} params.uid
* @param {number} params.limit
* @param {number=} params.offset
*/
export function userPlaylist(params) {
// limit : 返回数量 , 默认为 30
// offset : 偏移数量，用于分页 , 如 :( 页数 -1)*30, 其中 30 为 limit 的值 , 默认为 0
return request({
url: "/user/playlist",
method: "get",
@ -20,6 +35,12 @@ export function userPlaylist(params) {
});
}
/**
* 喜欢音乐列表
* 说明 : 调用此接口 , 传入用户 id, 可获取已喜欢音乐id列表(id数组)
* - uid: 用户 id
* @param {number} uid
*/
export function userLikedSongsIDs(uid) {
return request({
url: "/likelist",