歌曲别名 - Sodiumsss/QWQueue_API GitHub Wiki

API简介

API 方法 参数 请求成功返回 地址
添加歌曲别名 POST Alias(songId,text) R.success(data:新增别名的ID) /dev/alias/addSongAlias
删除歌曲别名（通过别名ID） POST Alias(songId) R.success() /dev/alias/deleteAliasByID
删除歌曲别名（通过别名） POST Alias(text) R.success() /dev/alias/deleteAliasByText
获取歌曲别名 POST Alias(text) R.success(data:拥有此别名歌曲的List < Alias >) /dev/alias/getSongAlias
获取歌曲别名的数量 POST Alias(songId) R.success(data:该歌曲别名的数量) /dev/alias/getSongAliasSize 
public class Alias {
    private Integer id;
    private Integer songId;
    private String text;
}

注意事项

  • 添加歌曲别名：如果Alias的text字段长度小于2或者大于15，服务端返回R.error("size")。如果该歌曲已经存在该别名，服务端返回R.error("added")。
  • 删除歌曲别名（通过别名ID）：是别名ID，不是歌曲ID。
  • 删除歌曲别名（通过别名）：如果该别名存在多条，服务端返回R.error("size")，请使用别名ID删除别名。
  • 获取歌曲别名：如果Alias的text字段长度小于2或者大于15，服务端返回R.error("size")。

示例

使用TypeScript，以获取歌曲别名为例：

const json=JSON.stringify({text:name});
const token="xxxxxxxxxxx";
axios.post("http://" + ip + ":" + port + "/dev/alias/getSongAlias", json,
            {headers:{'Content-Type': 'application/json','devToken':token}}).then((r:any)=>{
    if (r['code']===1) {
      const list :Array<any> = r['data'];
      if (list.length===0){
          //"未搜索到歌曲拥有此别名。"
      }else {
          //得到List<Alias>
          //其中Alias有字段：id、songId，无text字段
    }
    else { 
        //"获取失败！"  
    }
})

List< Alias >

[
    {
        "id": xxx,
        "songId": xxx,
        "text": null
    },
    {
    .....
    }
]
⚠️ **GitHub.com Fallback** ⚠️