NeteaseCloudMusicApi - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

app.js

@@ -16,2 +16,5 @@ const express = require('express')
 
+app.use('/album', require('./router/album'))
+
+
 app.use('/user/playlist', require('./router/userPlaylist'))
@@ -18,0 +21,0 @@

docs/README.md

 # NeteaseCloudMusicApi
-网易云音乐 nodejs 接口
 
+网易云音乐 NodeJS 版 API
 
+
 ## 版本新特性  
-增加使用文档,完成项目重构,版本升级到2.0,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
+版本升级到 2.0 .增加使用文档,完成项目重构,增加更完善的单元测试,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
 
@@ -37,4 +38,6 @@ ## 安装
 
+完成登录后,会在浏览器保存一个 cookie 用作登录凭证, 除了搜索的音乐和歌词,以及获取音乐 url 都需要用到这个 cookie  
 
-完成登录后,会在浏览器保存一个 cookie 用作登录凭证, 除了搜索的音乐和歌词,以及获取音乐 url 都需要用到这个 cookie
+#### 注意
+调用登录接口的速度比调用其他接口慢,因为登录过程调用了加密算法
 
@@ -60,3 +63,3 @@ ### 获取用户歌单
 ### 获取音乐 url
-说明:使用歌单详情接口后,能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口,传入的音乐 id,可以获取对应的音乐的 url(不需要登录)
+说明:使用歌单详情接口后,能得到的音乐的 id, 但不能得到的音乐 url, 调用此接口,传入的音乐 id,可以获取对应的音乐的 url(不需要登录)  
 接口地址:  
@@ -70,3 +73,16 @@ `playlist/detail`
 ### 搜索音乐
-说明:调用此接口,传入搜索关键词可以搜索该音乐,关键词可以多个,以空格隔开,如"周杰伦 搁浅"(不需要登录)
+说明:调用此接口,传入搜索关键词可以搜索该音乐,关键词可以多个,以空格隔开,如"周杰伦 搁浅"(不需要登录)  
+必选参数:
+keywords : 关键词
+可选参数:
+limit: 返回数量,默认为30 
+type: 搜索类型；默认为1,取值意义:  
+1: 单曲  
+10: 专辑  
+100: 歌手  
+1000: 歌单  
+1002: 用户  
+ 
+ offset: 偏移数量，用于分页  
+
 接口地址:  
@@ -80,3 +96,3 @@ `/search`
 ### 获取歌词
-说明:调用此接口,传入音乐 id 可获得对应音乐的歌词(不需要登录)
+说明:调用此接口,传入音乐 id 可获得对应音乐的歌词(不需要登录)  
 接口地址:  
@@ -89,2 +105,13 @@ `/lyric`
 
+### 获取歌手专辑列表
+说明:调用此接口,传入歌手 id,可获得歌手专辑列表  
+接口地址:  
+`/album`  
+调用例子:  
+`album?id=32311`  
+![获取专辑](https://raw.githubusercontent.com/Binaryify/NeteaseCloudMusicApi/master/static/%E4%B8%93%E8%BE%91.png)
+
+
+
+
 ### 获取每日推荐歌单
@@ -108,4 +135,6 @@ 说明:调用此接口,可获得每日推荐歌单(需要登录)
 
+## 离线访问此文档
+此文档同时也是 Progressive Web Apps(PWA), 加入了serviceWorker,可离线访问
 
 ## License
 [The MIT License (MIT)](LICENSE)

package.json

 {
   "name": "NeteaseCloudMusicApi",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "",
@@ -5,0 +5,0 @@ "scripts": {

README.MD

@@ -1,3 +0,3 @@
-# NeteaseCloudMusicApi
-网易云音乐 nodejs 接口
+# 网易云音乐 API
+网易云音乐 NodeJS 版 API
 <p>
@@ -9,3 +9,2 @@ <a href="https://www.npmjs.com/package/NeteaseCloudMusicApi"><img src="https://img.shields.io/npm/v/NeteaseCloudMusicApi.svg" alt="Version"></a>
 <a href="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi"><img src="https://codeclimate.com/github/Binaryify/NeteaseCloudMusicApi/badges/gpa.svg" /></a>
-<a href="https://travis-ci.org/Binaryify/NeteaseCloudMusicApi"><img src="https://api.travis-ci.org/Binaryify/NeteaseCloudMusicApi.svg?branch=master" /></a>
 </p>  
@@ -15,3 +14,3 @@
 ## 版本新特性  
-增加使用文档,完成项目重构,增加更完善的单元测试,版本升级到2.0,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
+版本升级到 2.0.增加使用文档,完成项目重构,增加更完善的单元测试,升级 api 到 v2+,支持登录并获取用户信息和创建的歌单,可通过获取音乐 url 接口获取用户歌单里的的音乐,获取每日推荐歌单和每日推荐音乐
 
@@ -18,0 +17,0 @@ ## 环境要求

router/search.js

@@ -9,3 +9,5 @@ const express = require("express")
   const limit = req.query.limit || 30
-  const data = 's=' + keywords + '&limit=' + limit + '&type=' + type + '&offset=0'
+  const offset = req.query.offset || 0
+
+  const data = 's=' + keywords + '&limit=' + limit + '&type=' + type + '&offset=' + offset
   createRequest('/api/search/pc/', 'POST', data)
@@ -12,0 +14,0 @@ .then(result => {

test/lyric.test.js

 const assert = require('assert')
 const crypto = require('crypto')
 const { createRequest } = require("../util/util")
-const phone = "换成你的账号"
-const password = "换成你的密码"
 
@@ -7,0 +5,0 @@ describe('测试获取歌词是否正常', () => {

test/musicUrl.test.js

 const assert = require('assert')
 const crypto = require('crypto')
 const { createWebAPIRequest } = require("../util/util")
-const phone = "换成你的账号"
-const password = "换成你的密码"
 
@@ -7,0 +5,0 @@ describe('测试获取歌曲是否正常', () => {

test/search.test.js

 const assert = require('assert')
 const crypto = require('crypto')
 const { createRequest } = require("../util/util")
-const phone = "换成你的账号"
-const password = "换成你的密码"
 
@@ -7,0 +5,0 @@ describe('测试搜索是否正常', () => {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5359837

increased by8.54%

Number of package files

42

increased by20%

Lines of code

682

increased by17.18%

Worsened metrics

Number of lines in readme file

43

decreased by-2.27%

No dependency changes