mirror of
https://gitlab.com/Binaryify/neteasecloudmusicapi.git
synced 2025-05-23 22:37:41 +08:00
215 lines
5.6 KiB
Markdown
215 lines
5.6 KiB
Markdown
# NeteaseCloudMusicApi
|
||
|
||
网易云音乐 NodeJS 版 API
|
||
|
||
|
||
## 版本新特性
|
||
版本升级到 2.0 .增加使用文档,完成项目重构,增加更完善的单元测试,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
|
||
|
||
## 安装
|
||
``` shell
|
||
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
|
||
$ npm install
|
||
```
|
||
## 运行
|
||
``` shell
|
||
$ node app.js
|
||
```
|
||
|
||
服务器启动,默认端口为3000
|
||
|
||
|
||
## 接口文档
|
||
|
||
### 登录
|
||
说明:登录有两个接口
|
||
#### 1. 手机登录
|
||
|
||
**必选参数:**
|
||
`phone`: 手机号码
|
||
`password`: 密码
|
||
|
||
**接口地址:**
|
||
`/login/cellphone`
|
||
|
||
**调用例子:**
|
||
`/login/cellphone?phone=xxx&password=yyy`
|
||
|
||
#### 2. 邮箱登录
|
||
|
||
**必选参数:**
|
||
`email`: 163网易邮箱
|
||
`password`: 密码
|
||
|
||
**接口地址:**
|
||
`/login`
|
||
|
||
**调用例子:**
|
||
`/login?email=xxx@163.com&password=yyy`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
|
||
完成登录后,会在浏览器保存一个 cookie 用作登录凭证, 除了搜索的音乐和歌词,以及获取音乐 url 都需要用到这个 cookie
|
||
|
||
#### 注意
|
||
调用登录接口的速度比调用其他接口慢,因为登录过程调用了加密算法
|
||
|
||
### 获取用户歌单
|
||
说明:登陆后调用此接口,传入用户 id, 可以获取用户歌单
|
||
|
||
**必选参数:**
|
||
`uid` : 用户 id
|
||
|
||
**接口地址:**
|
||
`/user/playlist`
|
||
|
||
**调用例子:**
|
||
`/user/playlist?uid=32953014`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取歌单详情
|
||
说明:歌单能看到歌单名字,但看不到具体歌单内容,调用此接口,传入歌单 id,可以获取对应歌单内的所有的音乐
|
||
|
||
**必选参数:**
|
||
`id` : 歌单 id
|
||
|
||
**接口地址:**
|
||
`playlist/detail`
|
||
|
||
**调用例子:**
|
||
`/playlist/detail?id=24381616`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取音乐 url
|
||
说明:使用歌单详情接口后,能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口,传入的音乐 id,可以获取对应的音乐的 url(不需要登录)
|
||
|
||
**必选参数:**
|
||
`id` : 音乐 id
|
||
|
||
**接口地址:**
|
||
`playlist/detail`
|
||
|
||
**调用例子:**
|
||
`/playlist/detail?id=24381616`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 搜索音乐
|
||
说明:调用此接口,传入搜索关键词可以搜索该音乐,关键词可以多个,以空格隔开,如"周杰伦 搁浅"(不需要登录)
|
||
|
||
**必选参数:**
|
||
`keywords` : 关键词
|
||
|
||
**可选参数:**
|
||
`limit` : 返回数量,默认为30
|
||
`type`: 搜索类型；默认为1,取值意义:
|
||
1: 单曲
|
||
10: 专辑
|
||
100: 歌手
|
||
1000: 歌单
|
||
1002: 用户
|
||
|
||
`offset` : 偏移数量，用于分页
|
||
|
||
**接口地址:**
|
||
`/search`
|
||
|
||
**调用例子:**
|
||
`/search?keywords=海阔天空`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取歌词
|
||
说明:调用此接口,传入音乐 id 可获得对应音乐的歌词(不需要登录)
|
||
|
||
**必选参数:**
|
||
`id`: 音乐 id
|
||
|
||
**接口地址:**
|
||
`/lyric`
|
||
|
||
**调用例子:**
|
||
`/lyric?id=347230`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取评论
|
||
说明:调用此接口,传入歌音乐 id和 limit 参数, 可获得该音乐的所有评论(不需要登录)
|
||
|
||
**必选参数:**
|
||
`id`: 音乐 id
|
||
|
||
**可选参数:**
|
||
`limit`: 取出评论数量,默认为20
|
||
|
||
**接口地址:**
|
||
`/comment`
|
||
|
||
**调用例子:**
|
||
`/comment?id=186016&limit=1`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取歌手专辑列表
|
||
说明:调用此接口,传入歌手 id,可获得歌手专辑列表
|
||
|
||
**必选参数:**
|
||
`id`: 歌手 id
|
||
|
||
**接口地址:**
|
||
`/album`
|
||
|
||
**调用例子:**
|
||
`album?id=32311`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
|
||
|
||
|
||
### 获取每日推荐歌单
|
||
说明:调用此接口,可获得每日推荐歌单(需要登录)
|
||
|
||
**接口地址:**
|
||
`/recommend/resource`
|
||
|
||
**调用例子:**
|
||
`/recommend/resource`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
### 获取每日推荐歌曲
|
||
说明:调用此接口,可获得每日推荐歌曲(需要登录)
|
||
|
||
**接口地址:**
|
||
`/recommend/songs`
|
||
|
||
**调用例子:**
|
||
`/recommend/songs`
|
||
|
||
返回数据如下图:
|
||
|
||
|
||
## 离线访问此文档
|
||
此文档同时也是 Progressive Web Apps(PWA), 加入了serviceWorker,可离线访问
|
||
|
||
|
||
## 关于此文档
|
||
此文档由 [docsify](https://github.com/QingWei-Li/docsify/) 生成
|
||
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。
|
||
|
||
## License
|
||
[The MIT License (MIT)](LICENSE)
|