music-api-next 中文文档

发布 : 2018-10-05 分类 : 开源项目 浏览 :

一个可以快速从 QQ 音乐、虾米音乐和网易音乐获得歌曲搜索结果、歌曲链接信息和歌曲评论的第三方库。

如果想了解更多关于如何使用music-api-next的知识,请去库的开发者的博客进行交流。如果需要提出 issues,欢迎来仓库地址

DOCS

中文文档

安装

1
npm install music-api-next --save

网速不好的中国用户,请使用cnpm安装:

1
cnpm install music-api-next --save

快速开始

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const musicAPI = require("music-api-next");

// 搜索接口: 返回指定关键词的搜索信息
musicAPI
.searchSong({
key: "周杰伦",
page: 1,
limit: 10,
vendor: "qq"
})
.then(songs => console.log(songs))
.catch(error => console.log(error.message));

// 歌曲信息接口: 返回指定歌曲的信息
musicAPI
.getSong({
id: "003OUlho2HcRHC",
vendor: "qq"
})
.then(meta => console.log(meta))
.catch(error => console.log(error.message));

// 评论接口: 返回指定歌曲的评论
musicAPI
.getComment({
id: "003OUlho2HcRHC",
page: 1,
limit: 20,
vendor: "qq"
})
.then(comments => console.log(comments))
.catch(error => console.log(error.message));

本地服务器

1
2
3
4
5
git clone git@github.com:dongyuanxin/music-api-next.git
cd music-api-next
npm install
// 启动服务器的监听端口: 5050
node server.js

启动服务器后,你可以直接在浏览器中访问 url 来查看结果。

例如:

  • Search API: http://localhost:5050/search/song?key=周杰伦&page=1&limit=10&vendor=qq
  • Song API: http://localhost:5050/get/song?id=003OUlho2HcRHC&vendor=qq
  • Comment API: http://localhost:5050/get/comment?id=003OUlho2HcRHC&page=1&limit=10&vendor=qq

配合webpack

首先,配合webpack进行打包。

1
2
3
4
5
6
git clone git@github.com:dongyuanxin/music-api-next.git
cd music-api-next
npm install
// use webpack to package program
// pacakged file named 'music-api-next.js' is placed in ./dist/
webpack

然后,你就可以直接移动打包好的music-api-next.js到工作目录。引用方法如下:

1
2
3
const musicAPI = require("./music-api-next");

// ...

API

  • musicAPI.searchSong(query):

    1
    2
    3
    4
    5
    6
    query: {
    key: String,
    page: Number,
    limit: Number,
    vendor: one of ['netease', 'xiami', 'qq']
    }
  • musicAPI.getSong(query):

    1
    2
    3
    4
    query: {
    id: String or Number,
    vendor: one of ['netease', 'xiami', 'qq']
    }
  • musicAPI.getComment(query):

    1
    2
    3
    4
    5
    6
    query: {
    id: String or Number,
    page: Number,
    limit: Number,
    vendor: one of ['netease', 'xiami', 'qq']
    }

警告

  1. 请不要用于商业用途
  2. 目前版本只能运行于 NodeJS
  3. 请友好地调用 API,以防对音乐平台造成过大压力

致谢

项目代码参考了以下 2 个开源项目。并且做了修复、改进和增加(在 NodeJS 中)。

  1. listen1_chrome_extension: 由于接收到了腾讯的律师函,可能会在 2018 年底停止维护。
  2. musicAPI: 停止维护 1 年多了,很多 API 已经失效。
本文作者 : 董沅鑫
原文链接 : https://godbmw.com/passages/2018-10-05-music-api-next-docs-zh/
版权声明 : 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明出处!

知识 & 情怀 | 二者兼得

微信扫一扫, 向我投食

微信扫一扫, 向我投食

支付宝扫一扫, 向我投食

支付宝扫一扫, 向我投食

留下足迹