NeteaseCloudMusicApi - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

app.js

@@ -10,2 +10,3 @@ const express = require('express')
 app.use('/login', require('./router/login'))
+
 //获取评论
@@ -54,2 +55,5 @@ app.use('/comment', require('./router/comment'))
 
+//排行榜
+app.use("/top_list",require("./router/top_list"))
+
 process.on('SIGHUP', () => {
@@ -56,0 +60,0 @@ console.log('server: bye bye')

CHANGELOG.MD

 # 更新日志
+### 2.3.0 | 2017.4.15
+增加排行榜接口,更新文档
+
 ### 2.2.0 |2017.4.14
@@ -3,0 +6,0 @@ 增加私人 FM, 喜欢歌曲,垃圾桶,每日签到等接口,更新文档

docs/README.md

@@ -5,4 +5,14 @@ # NeteaseCloudMusicApi
 
+## 灵感来自
+[disoul/electron-cloud-music](https://github.com/disoul/electron-cloud-music)
 
+[darknessomi/musicbox](https://github.com/darknessomi/musicbox)
+
+## 工作原理
+跨站请求伪造 (CSRF), 伪造请求头,调用官方 API
+
 ## 版本新特性  
+version 2.3.0
+增加排行榜接口
+
 Version 2.2.0  
@@ -37,6 +47,17 @@ 新增喜欢歌曲,私人 FM, 垃圾桶,签到等接口
 
-服务器启动,默认端口为3000
+服务器启动默认端口为3000,若不想使用3000端口,可使用以下命令:  
+Mac/Linux
+```shell
+$ PORT=4000 node app.js
+```
 
+windows 下使用 git-bash 或者 cmder 等终端执行以下命令:  
+```shell
+$ set PORT=4000 && node app.js
+```
 
+
 ## 接口文档
+### 调用前须知
+部分接口如登录接口不能调用太频繁,否则可能会触发503错误或者 ip 高频错误,若需频繁调用,需要准备 IP 代理池
 
@@ -253,3 +274,3 @@ ### 登录
 
-![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess)
+![签到成功](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinSuccess.png)
 
@@ -299,4 +320,43 @@ ![签到失败](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/signinError.png)
 
+### 排行榜
+说明:调用此接口,传入数字 idx, 可获取不同排行榜
 
+**必选参数:**   
+` idx`:  对象 key, 对应以下排行榜  
 
+```
+"0": 云音乐新歌榜,   
+"1": 云音乐热歌榜,  
+"2": 网易原创歌曲榜,  
+"3": 云音乐飙升榜,  
+"4": 云音乐电音榜,  
+"5": UK排行榜周榜,  
+"6": 美国Billboard周榜  
+"7": KTV嗨榜,  
+"8": iTunes榜,  
+"9": Hit FM Top榜,  
+"10": 日本Oricon周榜  
+"11": 韩国Melon排行榜周榜,  
+"12": 韩国Mnet排行榜周榜,  
+"13": 韩国Melon原声周榜,  
+"14": 中国TOP排行榜(港台榜),  
+"15": 中国TOP排行榜(内地榜)  
+"16": 香港电台中文歌曲龙虎榜,  
+"17": 华语金曲榜,  
+"18": 中国嘻哈榜,  
+"19": 法国 NRJ EuroHot 30周榜,  
+"20": 台湾Hito排行榜,  
+"21": Beatport全球电子舞曲榜 
+``` 
+
+**接口地址:**  
+`/top_list`  
+
+**调用例子:**  
+`/top_list?idx=6`  
+
+返回数据如下图: 
+
+![排行榜](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/top_list.png)
+
 ## 离线访问此文档
@@ -303,0 +363,0 @@ 此文档同时也是 Progressive Web Apps(PWA), 加入了serviceWorker,可离线访问

package.json

 {
   "name": "NeteaseCloudMusicApi",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "网易云音乐 NodeJS 版 API",
@@ -5,0 +5,0 @@ "scripts": {

README.MD

@@ -17,2 +17,5 @@ # 网易云音乐 API
 ## 版本新特性  
+### 2.3.0 | 2017.4.15
+增加排行榜接口,更新文档
+
 ### 2.2.0 | 2017.4.14
@@ -54,7 +57,18 @@ 增加私人 FM, 喜欢歌曲,垃圾桶,每日签到等接口,更新文档
 ```
+服务器启动默认端口为3000,若不想使用3000端口,可使用以下命令:  
+Mac/Linux
+```shell
+$ PORT=4000 node app.js
+```
 
+windows 下使用 git-bash 或者 cmder 等终端执行以下命令:  
+```shell
+$ set PORT=4000 && node app.js
+```
+
 ## 使用文档
-
 [文档地址](https://binaryify.github.io/NeteaseCloudMusicApi)
 
+![文档](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/docs.png)
+
 ## 更新日志
@@ -61,0 +75,0 @@ [changelog](https://github.com/Binaryify/NeteaseCloudMusicApi/blob/master/CHANGELOG.MD)

No alert changes

Improved metrics

Total package byte prevSize

7957608

increased by15.1%

Number of package files

60

increased by5.26%

Lines of code

875

increased by4.92%

Number of lines in readme file

86

increased by19.44%

No dependency changes