mirror of
https://github.com/GiriNeko/YesPlayMusic.git
synced 2025-12-18 14:18:03 +00:00
feat: update api comments with jsdoc. (#52)
This commit is contained in:
parent
e9b6a81bef
commit
4e482941ed
9 changed files with 189 additions and 43 deletions
|
|
@ -1,6 +1,21 @@
|
|||
import request from "@/utils/request";
|
||||
import { mapTrackPlayableStatus } from "@/utils/common";
|
||||
|
||||
/**
|
||||
* 搜索
|
||||
* 说明 : 调用此接口 , 传入搜索关键词可以搜索该音乐 / 专辑 / 歌手 / 歌单 / 用户 , 关键词可以多个 , 以空格隔开 ,
|
||||
* 如 " 周杰伦 搁浅 "( 不需要登录 ), 搜索获取的 mp3url 不能直接用 , 可通过 /song/url 接口传入歌曲 id 获取具体的播放链接
|
||||
* - keywords : 关键词
|
||||
* - limit : 返回数量 , 默认为 30
|
||||
* - offset : 偏移数量,用于分页 , 如 : 如 :( 页数 -1)*30, 其中 30 为 limit 的值 , 默认为 0
|
||||
* - type: 搜索类型;默认为 1 即单曲 , 取值意义 : 1: 单曲, 10: 专辑, 100: 歌手, 1000: 歌单, 1002: 用户, 1004: MV, 1006: 歌词, 1009: 电台, 1014: 视频, 1018:综合
|
||||
* - 调用例子 : /search?keywords=海阔天空 /cloudsearch?keywords=海阔天空(更全)
|
||||
* @param {Object} params
|
||||
* @param {string} params.keywords
|
||||
* @param {number=} params.limit
|
||||
* @param {number=} params.offset
|
||||
* @param {number=} params.type
|
||||
*/
|
||||
export function search(params) {
|
||||
return request({
|
||||
url: "/search",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue