README.MD 4.4 KB
Newer Older
B
binaryify 已提交
1
# 网易云音乐 API
2

W
improve  
waterdanceTV 已提交
3
网易云音乐 Node.js API service
4

zhuangtongfa's avatar
zhuangtongfa 已提交
5
<p>
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
6
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/npm/v/NeteaseCloudMusicApi.svg" alt="Version"></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
7
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/npm/l/NeteaseCloudMusicApi.svg" alt="License"></a>
zhuangtongfa's avatar
zhuangtongfa 已提交
8 9
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/david/dev/binaryify/NeteaseCloudMusicApi.svg" alt="devDependencies" ></a>
<a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/david/binaryify/NeteaseCloudMusicApi.svg" alt="devDependencies" ></a>
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
10
<a href="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi"><img src="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi/badges/gpa.svg" /></a>
11
</p>
zhuangtongfa's avatar
zhuangtongfa 已提交
12

13
## 灵感来自
14

15 16 17
[disoul/electron-cloud-music](https://github.com/disoul/electron-cloud-music)

[darknessomi/musicbox](https://github.com/darknessomi/musicbox)
18

B
binaryify 已提交
19 20
[sqaiyan/netmusic-node](https://github.com/sqaiyan/netmusic-node)

21
## 功能特性
22

B
binaryify 已提交
23

24
1. 登录
B
binaryify 已提交
25
2. 刷新登录
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
3. 发送验证码
4. 校验验证码
5. 注册(修改密码)
6. 获取用户信息 , 歌单,收藏,mv, dj 数量
7. 获取用户歌单
8. 获取用户电台
9. 获取用户关注列表
10. 获取用户粉丝列表
11. 获取用户动态
12. 获取用户播放记录
13. 获取精品歌单
14. 获取歌单详情
15. 搜索
16. 搜索建议
17. 获取歌词
18. 歌曲评论
19. 收藏单曲到歌单
20. 专辑评论
21. 歌单评论
22. mv 评论
23. 电台节目评论
24. banner
25. 获取歌曲详情
26. 获取专辑内容
27. 获取歌手单曲
28. 获取歌手 mv
29. 获取歌手专辑
30. 获取歌手描述
31. 获取相似歌手
32. 获取相似歌单
33. 相似 mv
34. 获取相似音乐
35. 获取最近 5 个听了这首歌的用户
36. 获取每日推荐歌单
37. 获取每日推荐歌曲
38. 私人 FM
39. 签到
40. 喜欢音乐
41. 垃圾桶
42. 歌单 ( 网友精选碟 )
43. 新碟上架
44. 热门歌手
45. 最新 mv
46. 推荐 mv
47. 推荐歌单
48. 推荐新音乐
49. 推荐电台
50. 推荐节目
51. 独家放送
52. mv 排行
53. 获取 mv 数据
54. 播放 mv/视频
55. 排行榜
56. 歌手榜
57. 云盘
58. 电台 - 推荐
59. 电台 - 分类
60. 电台 - 分类推荐
61. 电台 - 订阅
62. 电台 - 详情
63. 电台 - 节目
64. 给评论点赞
65. 获取动态
66. 获取热搜
67. 发送私信
68. 发送私信歌单
69. 新建歌单
70. 收藏/取消收藏歌单
71. 歌单分类
72. 收藏的歌手列表
73. 订阅的电台列表
74. 相关歌单推荐
75. 付费精选接口
76. 音乐是否可用检查接口
77. 登录状态
78. 获取视频数据
79. 发送/删除评论
80. 热门评论
81. 视频评论
82. 退出登录
83. 所有榜单
84. 所有榜单内容摘要
85. 收藏视频
86. 收藏 MV
87. 视频详情
88. 相关视频
89. 关注用户
90. 新歌速递
91. 喜欢音乐列表(无序)
92. 收藏的 MV 列表
93. 获取最新专辑
94. 听歌打卡
95. 获取视频标签下的视频
96. 已收藏专辑列表
97. 获取动态评论
98. 歌单收藏者列表
B
binaryify 已提交
122 123 124 125 126 127
99. 云盘歌曲删除
100. 热门话题
101. 电台 - 推荐类型
102. 电台 - 非热门类型
103. 电台 - 今日优选
104. 心动模式/智能播放
B
binaryify 已提交
128

129
## 环境要求
130

B
binaryify 已提交
131
需要 NodeJS 8.12+ 环境
zhuangtongfa's avatar
init  
zhuangtongfa 已提交
132

133
## 安装
134 135

```shell
136 137
$ git clone git@github.com:Binaryify/NeteaseCloudMusicApi.git
$ npm install
138
```
139

140
## 运行
141 142

```shell
143
$ node app.js
144
```
145 146 147

服务器启动默认端口为 3000,若不想使用 3000 端口,可使用以下命令: Mac/Linux

B
binaryify 已提交
148 149 150 151
```shell
$ PORT=4000 node app.js
```

152
windows 下使用 git-bash 或者 cmder 等终端执行以下命令:
153

B
binaryify 已提交
154 155 156
```shell
$ set PORT=4000 && node app.js
```
157

158
## 使用文档
159

160
[文档地址](https://binaryify.github.io/NeteaseCloudMusicApi)
161

B
improve  
binaryify 已提交
162 163
![文档](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/docs.png)

164
## 更新日志
165

166
[changelog](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/CHANGELOG.MD)
B
binaryify 已提交
167

168
## 单元测试
169

170
```shell
171
$ npm test
172
```
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
173

174 175
![单元测试](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/screenshot1.png)
![单元测试](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/screenshot2.png)
zhuangtongfa's avatar
update  
zhuangtongfa 已提交
176

B
improve  
binaryify 已提交
177
## 贡献者
B
binaryify 已提交
178
![](https://opencollective.com/NeteaseCloudMusicApi/contributors.svg?width=890)
B
improve  
binaryify 已提交
179 180


181
## License
182

B
improve  
binaryify 已提交
183
[The MIT License (MIT)](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/LICENSE)